Skip to content

ci: Make cli-docs-bot the author of docs update commits - #121

Merged
adamwg merged 2 commits into
crossplane:mainfrom
adamwg:awg/docs-pr-author
Jun 16, 2026
Merged

adamwg merged 2 commits into
crossplane:mainfrom
adamwg:awg/docs-pr-author

Conversation

@adamwg

@adamwg adamwg commented Jun 16, 2026

Copy link
Copy Markdown
Member

Description of your changes

The Signed-off-by line should match the commit author, and this also makes it clearer that the docs update was automated rather than being done by a human.

I have:

The Signed-off-by line should match the commit author, and this also makes it
clearer that the docs update was automated rather than being done by a human.

Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
@adamwg
adamwg requested review from a team, jcogilvie and tampakrap as code owners June 16, 2026 17:27
@adamwg
adamwg requested review from negz and removed request for a team June 16, 2026 17:27
@coderabbitai

coderabbitai Bot commented Jun 16, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7a955309-2214-4e2c-a244-bb915fc78128

📥 Commits

Reviewing files that changed from the base of the PR and between e1f5cdc and a80988b.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml
✅ Files skipped from review due to trivial changes (1)
  • .github/workflows/ci.yml

📝 Walkthrough

Walkthrough

The CI workflow updates the docs PR commit-message template to include an author: cli-docs-bot <info@crossplane.io> line in the Create docs PR step.

Changes

Docs PR author metadata

Layer / File(s) Summary
Commit message author line
.github/workflows/ci.yml
The Create docs PR workflow step adds an author line to the commit-message template used for docs updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • crossplane/cli#120: Also updates the Create docs PR commit-message block in .github/workflows/ci.yml with additional commit metadata.
  • crossplane/cli#106: Also changes the docs PR automation flow in .github/workflows/ci.yml, including the same docs update path.

Suggested reviewers

  • tampakrap
  • jcogilvie
  • phisco
  • jbw976
🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and descriptively summarizes the main change: making cli-docs-bot the author of documentation update commits.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale for updating the CI commit configuration and commit author.
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.
Breaking Changes ✅ Passed Only .github/workflows/ci.yml was modified; no changes to apis/** or cmd/** directories, so breaking changes check does not apply.
Feature Gate Requirement ✅ Passed This PR only modifies CI workflow configuration (.github/workflows/ci.yml) for commit attribution of automated docs updates. It introduces no new features, makes no changes to apis/**, and adds no...

✏️ 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.

❤️ Share

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

Comment thread .github/workflows/ci.yml
Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}

Signed-off-by: cli-docs-bot <info@crossplane.io>
author: cli-docs-bot <info@crossplane.io>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From coderabbit's original comment in #120 (comment), should you also set signoff: true and remove the hard coded Signed-off-by: portion of the commit-message?

So something like:

commit-message: |
  Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
author: cli-docs-bot <info@crossplane.io>
committer: cli-docs-bot <info@crossplane.io> # maybe this one is optional since we've already specified author
signoff: true

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, I completely missed the signoff option in the docs. Updated.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's okay, you don't care what your esteemed and respected colleague code bunny has to say 😂

Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
@adamwg
adamwg merged commit 3e9e14f into crossplane:main Jun 16, 2026
10 checks passed
@adamwg
adamwg deleted the awg/docs-pr-author branch June 16, 2026 18:45
social4hyq pushed a commit to social4hyq/homebrew-core that referenced this pull request Sep 20, 2026
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants