chore(docs): update otdfctl references to platform monorepo by alkalescent · Pull Request #309 · opentdf/docs

alkalescent · 2026-04-29T16:21:41Z

Summary

Update all opentdf/otdfctl references to opentdf/platform monorepo
The opentdf/otdfctl repo is archived; CLI now lives under otdfctl/ in the platform repo
Updates install script, docusaurus remote content plugin, GitHub Actions workflow, and doc links

Summary by CodeRabbit

Documentation
- Updated CLI documentation links and references to point to the centralized platform repository and adjusted displayed release notes scope.
Chores
- Updated installer and download links to fetch CLI releases from the centralized platform repository.
- Updated build/workflow steps to pull CLI documentation and metadata from the centralized platform source.
- Updated UI link for downloading the latest CLI release.

The opentdf/otdfctl repo is archived. The CLI now lives in opentdf/platform under otdfctl/. Update all references across install scripts, docusaurus config, workflows, and docs. DSPX-2712

coderabbitai · 2026-04-29T16:21:51Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d8788d6e-7ad8-48cd-af28-ac43afc9a9e6

📥 Commits

Reviewing files that changed from the base of the PR and between d7f75e7 and 92a027c.

📒 Files selected for processing (1)

.github/workflows/otdfctl-update.yaml

🚧 Files skipped from review as they are similar to previous changes (1)

.github/workflows/otdfctl-update.yaml

📝 Walkthrough

Walkthrough

The PR migrates references and sources for otdfctl from the standalone opentdf/otdfctl repository to the opentdf/platform repository (where otdfctl now lives as a subdirectory). Changes touch CI workflow, docs links, site config, frontend link targets, and the installer script.

Changes

Cohort / File(s)	Summary
CI/CD & Workflow `.github/workflows/otdfctl-update.yaml`	Switched git remote and tree reads to `opentdf/platform`, changed PR existence check variable assignment, and updated commit-hash lookup to use the `platform` remote; adjusted generated metadata `source` URL to point into `platform/tree/$TAG/otdfctl`.
Site config & docs source `docusaurus.config.ts`, `docs/release-notes.mdx`	Retargeted remote-content config to `opentdf/platform`, updated document glob/filename rewrites for the `otdfctl/` subdirectory, and changed release notes source to filter `otdfctl` under `platform`.
Documentation pages `README.md`, `docs/components/policy/keymanagement/base_key.md`, `docs/components/policy/keymanagement/quickstart.md`, `docs/getting-started/index.mdx`, `docs/getting-started/quickstart.mdx`, `docs/guides/subject-mapping-guide.md`	Replaced links and references from `opentdf/otdfctl` to `opentdf/platform/.../otdfctl` for CLI docs, quickstart, installer notes, and action references.
Frontend & installer `src/components/landing/DeveloperFirst.tsx`, `static/quickstart/install.sh`	Updated CLI release URL to platform releases filtered for `otdfctl`; installer now queries `opentdf/platform` releases, parses `otdfctl/<version>`-prefixed `tag_name` values, and downloads assets from `platform` release assets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

marythought
elizabethhealy
jp-ayyappan

Poem

🐰 I hopped through links and learned to roam,
From lone repo burrow to platform home,
URLs refreshed, docs all aligned,
A tidy path the web will find,
Hooray — the CLI's new address, sublime! 🥕✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: updating otdfctl references from the archived standalone repository to the opentdf/platform monorepo.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch DSPX-2712/update-otdfctl-source-location

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Review rate limit: 0/1 reviews remaining, refill in 60 minutes.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-04-29T16:25:57Z

📄 Preview deployed to https://opentdf-docs-pr-309.surge.sh

gemini-code-assist

Code Review

This pull request migrates all references, documentation links, and build configurations from the standalone opentdf/otdfctl repository to its new location within the opentdf/platform monorepo. Key changes include updating Docusaurus remote repository settings, adjusting the install.sh script to handle the new release tag format, and correcting documentation links across various guides. A review comment suggests making the CLI branch configurable via an environment variable in the Docusaurus configuration to align with the project's documentation.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

alkalescent · 2026-04-29T17:12:34Z

verified that new otdfctl docs appear in preview link

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/otdfctl-update.yaml:
- Line 41: The COMMIT_HASH assignment is using bash array syntax
(COMMIT_HASH=(...)) which prevents the git ls-remote command from executing;
change the assignment to use command substitution (COMMIT_HASH=$(git ls-remote
--heads platform "refs/heads/$TAG" | awk '{ print $1 }')) so the command runs
and COMMIT_HASH contains the actual hash; update the line where COMMIT_HASH is
set to use $(...) instead of (...) and keep the existing git ls-remote and awk
pipeline intact.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 07d2456a-7f25-4b81-9974-fcc29af15a60

📥 Commits

Reviewing files that changed from the base of the PR and between 5eeb113 and d7f75e7.

📒 Files selected for processing (11)

.github/workflows/otdfctl-update.yaml
README.md
docs/components/policy/keymanagement/base_key.md
docs/components/policy/keymanagement/quickstart.md
docs/getting-started/index.mdx
docs/getting-started/quickstart.mdx
docs/guides/subject-mapping-guide.md
docs/release-notes.mdx
docusaurus.config.ts
src/components/landing/DeveloperFirst.tsx
static/quickstart/install.sh

PR_EXISTS and COMMIT_HASH were using bash array syntax (...) instead of command substitution $(...), preventing the commands from executing.

marythought

🚀

chore(docs): update otdfctl references to platform monorepo

985be5d

The opentdf/otdfctl repo is archived. The CLI now lives in opentdf/platform under otdfctl/. Update all references across install scripts, docusaurus config, workflows, and docs. DSPX-2712

gemini-code-assist Bot reviewed Apr 29, 2026

View reviewed changes

Comment thread docusaurus.config.ts Outdated

Update docusaurus.config.ts

d7f75e7

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

alkalescent marked this pull request as ready for review April 29, 2026 17:06

alkalescent requested review from a team as code owners April 29, 2026 17:06

coderabbitai Bot reviewed Apr 29, 2026

View reviewed changes

Comment thread .github/workflows/otdfctl-update.yaml Outdated

fix(ci): use command substitution in otdfctl-update workflow

92a027c

PR_EXISTS and COMMIT_HASH were using bash array syntax (...) instead of command substitution $(...), preventing the commands from executing.

marythought approved these changes Apr 29, 2026

View reviewed changes

alkalescent merged commit fb6c9b2 into main Apr 29, 2026
11 checks passed

alkalescent deleted the DSPX-2712/update-otdfctl-source-location branch April 29, 2026 19:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(docs): update otdfctl references to platform monorepo#309

chore(docs): update otdfctl references to platform monorepo#309
alkalescent merged 3 commits intomainfrom
DSPX-2712/update-otdfctl-source-location

alkalescent commented Apr 29, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 29, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

alkalescent commented Apr 29, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

marythought left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

alkalescent commented Apr 29, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

github-actions Bot commented Apr 29, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

alkalescent commented Apr 29, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marythought left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alkalescent commented Apr 29, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 29, 2026 •

edited

Loading