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

ci: Make cli-docs-bot the author of docs update commits#121
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
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