Repository navigation
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>
crossplane 2.4.0 Created-by: HarmonybrewBot Commit-by: HarmonybrewBot Merged-by: HarmonybrewBot Description: Created by `brew bump` --- Created with `brew bump-formula-pr`.<details> <summary>release notes</summary> <pre>The `v2.4.0` release is the first Crossplane CLI release that does not correspond to a Crossplane core release. It is compatible with the currently supported minor versions of Crossplane core: v2.3, v2.2, v2.1, and v1.20. It includes a number of incremental features and improvements along with many bug fixes. ## 🚨 Installation Note Since this release does not correspond to a Crossplane core release, it will not be uploaded to [releases.crossplane.io](https://releases.crossplane.io). Its artifacts are available only from [cli.crossplane.io](https://cli.crossplane.io). The `install.sh` script will install it from the correct location. ## 🎉 Highlights * **New Commands** * `crossplane xr generate` converts a claim to a composite resource, as Crossplane would do internally when a claim is applied to a cluster. #13 * `crossplane xr patch` applies defaults from an XRD to an input XR, as the apiserver would do when an XR is applied to a cluster. #61 * `crossplane xpkg get-crds` downloads package dependencies based on a `crossplane.yaml` file or package resource and writes their CRDs to files. #26 * **Command Updates** * `crossplane project init` now allows a repository to be specified. #105 * `crossplane resource validate` now has YAML and JSON output formats. #66 * `crossplane xpkg push` now allows OCI manifest annotations to be specified with the `--oci-annotation` flag. #11 * `crossplane composition render` now supports repeating the `--required-resources` and `--extra-resources` flags. #107 * Commands that interact with a cluster (e.g., `crossplane resource trace` and `crossplane xpkg install`) now support impersonation with the `--as`, `--as-group`, and `--as-uid` flags. #114 * **Developer Experience Updates** * Projects can now include pre-built functions specified in the `crossplane-project.yaml` file, allowing functions to be built using any language, tool, or framework. #24 * Projects can now specify a subset of languages for which schemas should be generated in the `crossplane-project.yaml` file. #24 ## What's Changed * Update dependencies and renovate for v2.3.0 release (main) by @adamwg in crossplane/cli#19 * ci: Remove image promotion steps by @adamwg in crossplane/cli#22 * build: Use the shared crossplane cachix cache in nix.sh by @adamwg in crossplane/cli#17 * Add the LICENSE file by @adamwg in crossplane/cli#27 * chore(deps): update module github.com/containerd/containerd to v1.7.32 [security] (main) by @crossplane-renovate[bot] in crossplane/cli#34 * chore(deps): update module github.com/sigstore/cosign/v2 to v2.6.2 [security] (main) by @crossplane-renovate[bot] in crossplane/cli#35 * chore(deps): update module golang.org/x/crypto to v0.52.0 [security] (main) by @crossplane-renovate[bot] in crossplane/cli#36 * Improve generation of reference docs by @adamwg in crossplane/cli#30 * chore(deps): update module golang.org/x/net to v0.55.0 [security] (main) by @crossplane-renovate[bot] in crossplane/cli#37 * chore(deps): update actions/create-github-app-token digest to fee1f7d (main) by @crossplane-renovate[bot] in crossplane/cli#52 * Update CONTRIBUTING.md and add install instructions to README.md by @adamwg in crossplane/cli#49 * Add the install.sh script and upload it to S3 by @adamwg in crossplane/cli#54 * docs: Enclose the CLI version number in backticks by @adamwg in crossplane/cli#55 * fix(docs): compile the bqRE once at package level by @tampakrap in crossplane/cli#57 * chore(deps): update actions/stale digest to eb5cf3a (main) by @crossplane-renovate[bot] in crossplane/cli#58 * feat(xr): Convert a Claim to XR via `crossplane xr generate` by @tampakrap in crossplane/cli#13 * chore(deps): pin dependencies (main) by @crossplane-renovate[bot] in crossplane/cli#51 * chore(deps): update cachix/install-nix-action digest to 8aa0397 (main) by @crossplane-renovate[bot] in crossplane/cli#60 * fix(deps): update module github.com/go-git/go-git/v5 to v5.19.1 [security] (main) by @crossplane-renovate[bot] in crossplane/cli#40 * render: Sync render.proto with c/c and wire XRD through by @jcogilvie in crossplane/cli#74 * Fix Python schema generation for fields named int or bool by @negz in crossplane/cli#64 * chore(deps): update actions/checkout digest to df4cb1c (main) by @crossplane-renovate[bot] in crossplane/cli#76 * chore(deps): update codecov/codecov-action digest to 75cd116 (main) by @crossplane-renovate[bot] in crossplane/cli#77 * chore(deps): update github/codeql-action digest to 8aad20d (main) by @crossplane-renovate[bot] in crossplane/cli#80 * chore(deps): update mheap/require-checklist-action digest to 9c8100a (main) by @crossplane-renovate[bot] in crossplane/cli#81 * Support pre-built function runtimes and per-language schema generation by @negz in crossplane/cli#24 * render: Clean up unused code and duplicate consts by @adamwg in crossplane/cli#83 * render: Replace condition timestamps and sort resources to stabilize output by @adamwg in crossplane/cli#82 * feat(render): capture stderr and handle pipeline-fatal exit code in both engines by @jcogilvie in crossplane/cli#91 * chore(deps): update actions/checkout action to v6.0.3 (main) by @crossplane-renovate[bot] in crossplane/cli#84 * chore(deps): update vale-cli/vale-action action to v2.1.2 (main) by @crossplane-renovate[bot] in crossplane/cli#85 * feat(xr): Introduce `xr patch --xrd` by @tampakrap in crossplane/cli#61 * Update the CLI docs path by @adamwg in crossplane/cli#99 * fix(xr): add missing import, caused by merge of outdated base tree by @tampakrap in crossplane/cli#103 * ci: Update the CLI reference documentation on every merge by @adamwg in crossplane/cli#106 * feat(validate): structured results and --output json|yaml flag by @jcogilvie in crossplane/cli#66 * function: Add missing dependencies to the Go function template by @adamwg in crossplane/cli#109 * xrd: Opportunistically infer integer types when generating from an XR by @adamwg in crossplane/cli#108 * feat: add xpkg get-crds subcommand by @fernandezcuesta in crossplane/cli#26 * Drop the scale subresource before building OpenAPI for schema generation by @negz in crossplane/cli#119 * ci: Re-use exising docs PRs and sign off on commits by @adamwg in crossplane/cli#120 * ci: Make cli-docs-bot the author of docs update commits by @adamwg in crossplane/cli#121 * xrd: Handle v2 XRDs in `crossplane xrd convert` by @adamwg in crossplane/cli#122 * fix(render): do not overwrite function docker network if set, start crossplane-container in same network by @nkzk in crossplane/cli#65 * chore(deps): update codecov/codecov-action digest to 0fb7174 (main) by @crossplane-renovate[bot] in crossplane/cli#101 * chore(deps): update korthout/backport-action action to v4.5.2 (main) by @crossplane-renovate[bot] in crossplane/cli#102 * Expose host-native CLI binary as the default flake package by @negz in crossplane/cli#126 * chore(deps): pin dependencies (main) by @crossplane-renovate[bot] in crossplane/cli#128 * chore(deps): update renovatebot/github-action action to v46.1.15 (main) by @crossplane-renovate[bot] in crossplane/cli#129 * Decompress function runtime tarballs once when loading by @negz in crossplane/cli#127 * fix: loaded XRD must honor the composite schema by @fernandezcuesta in crossplane/cli#123 * schemas: Prime oapi-codegen's global state to make capitalization consistent by @adamwg in crossplane/cli#130 * Add repository option to `crossplane project init` by @bobh66 in crossplane/cli#105 * feat(xpkg): add --annotation flag to xpkg build and xpkg push by @chaitanyapantheor in crossplane/cli#11 * fix(render): support repeating --required-resources and --extra-resources by @chaitanyapantheor in crossplane/cli#107 * fix(deps): update module github.com/alecthomas/kong to v1.15.0 (main) by @crossplane-renovate[bot] in crossplane/cli#133 * chore(deps): update module github.com/containerd/containerd to v1.7.33 [security] (main) by @crossplane-renovate[bot] in crossplane/cli#132 * fix(deps): update module github.com/oapi-codegen/oapi-codegen/v2 to v2.7.1 (main) by @crossplane-renovate[bot] in crossplane/cli#88 * fix(deps): update module github.com/kubernetes-sigs/kro to v0.9.2 (main) by @crossplane-renovate[bot] in crossplane/cli#87 * fix(deps): update module github.com/google/go-containerregistry to v0.21.7 (main) by @crossplane-renovate[bot] in https://github.com/crossplane/ See merge request: Harmonybrew/homebrew-core!12309
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.