ci: Update the CLI reference documentation on every merge#106
Conversation
|
I've tested this using my own fork of c/cli and c/docs:
|
|
Warning Review limit reached
More reviews will be available in 25 minutes and 26 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pull request modifies the CI workflow to expose the build version as a reusable job output and adds automated pull request creation for CLI documentation updates. The ChangesCI Workflow Enhancements
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Possibly related PRs
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.
Actionable comments posted: 2
🤖 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.
Inline comments:
In @.github/workflows/ci.yml:
- Around line 239-244: The parsing bug is that the deleted counter is assigned
from the added column; update the deleted assignment so deleted reads the second
field from diffstat instead of the first (change the deleted variable assignment
that currently uses $1 to use $2), leaving diffstat, added and changed logic
intact so the gating condition using added/deleted works correctly.
- Around line 248-256: Replace the floating action reference
"actions/create-github-app-token@v2" in the workflow step with a pinned full
commit SHA (for example use the same SHA used in .github/workflows/renovate.yml:
fee1f7d63c2ff003460e3d139729b119787bc349) so the step id "generate-token" uses a
fixed action commit; also review and document the CLI_DOCS_BOT GitHub App
permissions used by the inputs (app-id/private-key/owner/repositories) and
restrict them to the least-privilege required for creating/updating PRs in the
crossplane/docs repo (e.g., only repository contents, pull requests or checks as
needed) and confirm those minimal permissions in the workflow or repo security
notes.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 492c4275-2263-40cf-8611-57c28a4c6e43
📒 Files selected for processing (1)
.github/workflows/ci.yml
The CLI documentation is versioned, and its "master" version should reflect what's currently in our main branch. Since our reference docs are auto-generated by the `generate-docs` command, this means we can automatically keep the "master" docs in sync with our main branch by updating them from CI. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Description of your changes
The CLI documentation is versioned, and its "master" version should reflect what's currently in our main branch. Since our reference docs are auto-generated by the
generate-docscommand, this means we can automatically keep the "master" docs in sync with our main branch by updating them from CI.Toward #31
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.