Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamwg merged 2 commits into from
Jun 16, 2026
+3 −4
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1f5cdc
ci: Make cli-docs-bot the author of docs update commits
adamwg Jun 16, 2026
a80988b
ci: Configure the create-pull-request action to sign off on commits
adamwg Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,10 +260,9 @@ jobs:
with:
token: ${{ steps.generate-token.outputs.token }}
path: ./docs
commit-message: |
Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}

Signed-off-by: cli-docs-bot <info@crossplane.io>
commit-message: Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
author: cli-docs-bot <info@crossplane.io>

@jbw976 jbw976 Jun 16, 2026

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

@adamwg adamwg Jun 16, 2026

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.

@jbw976 jbw976 Jun 16, 2026

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 😂

signoff: true
title: Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
# We use a static branch name so that if an existing PR is already
# open it gets updated, rather than opening a sequence of PRs of which
Expand Down
Loading