Update the CLI docs path#99
Conversation
The CLI docs are now versioned separately from the rest of the docs, in preparation for the CLI version diverging from core. Update it in our contributing docs and the CI jobs where we validate generated docs changes. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Ensure stable help output (and generated documentation) by sorting the template names in the dynamically-generated part of the `crossplane xpkg init` help. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
📝 WalkthroughWalkthroughThis PR updates documentation paths and ensures deterministic help output. The docs generation path shifts from ChangesDocumentation and help output improvements
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/workflows/ci.yml (1)
205-205: Keep the CLI docs path updates consistent (and make it a bit more robust)
generate-docs, Vale, and the failure diagnostic all reference./docs/content/cli/master/command-reference.mdconsistently, so they’ll stay aligned.- The checked-out
crossplane/docsrepo containscontent/cli/master/, soos.WriteFile(... )shouldn’t fail due to a missing parent directory; optional safeguard: addmkdir -p ./docs/content/cli/masterbeforegenerate-docs.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/ci.yml at line 205, The CI step uses ./bin/linux_amd64/crossplane generate-docs -o ./docs/content/cli/master/command-reference.md but can fail if the target directory is missing; ensure the job creates the parent directory first by running a mkdir -p ./docs/content/cli/master before invoking the generate-docs command and confirm any related Vale or failure-diagnostic steps continue to reference the exact same ./docs/content/cli/master/command-reference.md path so all references remain consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/workflows/ci.yml:
- Line 205: The CI step uses ./bin/linux_amd64/crossplane generate-docs -o
./docs/content/cli/master/command-reference.md but can fail if the target
directory is missing; ensure the job creates the parent directory first by
running a mkdir -p ./docs/content/cli/master before invoking the generate-docs
command and confirm any related Vale or failure-diagnostic steps continue to
reference the exact same ./docs/content/cli/master/command-reference.md path so
all references remain consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 0fae41d8-8e0a-499a-8636-9509af9a58a4
⛔ Files ignored due to path filters (1)
cmd/crossplane/docs-templates/command-reference.md.tmplis excluded by none and included by none
📒 Files selected for processing (3)
.github/workflows/ci.ymlCONTRIBUTING.mdcmd/crossplane/xpkg/init.go
Description of your changes
The CLI docs are now versioned separately from the rest of the docs, in preparation for the CLI version diverging from core. Update it in our contributing docs and the CI jobs where we validate generated docs changes. Also update the docs template to match the current documentation page.
While we're here, make the dynamically generated help for
crossplane xpkg initstable across runs by sorting the template names. This will reduce unnecessary churn when we automate docs updates.I have:
./nix.sh flake checkto ensure this PR is ready for review.- [ ] Added or updated unit tests.- [ ] Linked a PR or a docs tracking issue to document this change.- [ ] Addedbackport release-x.ylabels to auto-backport this PR.