Skip to content

ci: Re-use exising docs PRs and sign off on commits #120

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
Merged

ci: Re-use exising docs PRs and sign off on commits #120

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13c975f
ci: Re-use the existing docs update PR if it's still open
adamwg Jun 15, 2026
e3871f9
ci: Sign off on docs update commits
adamwg Jun 15, 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
10 changes: 8 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,13 @@ jobs:
with:
token: ${{ steps.generate-token.outputs.token }}
path: ./docs
commit-message: Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
commit-message: |
Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}

Signed-off-by: cli-docs-bot <info@crossplane.io>
title: Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
Comment on lines +263 to 267

@coderabbitai coderabbitai Bot Jun 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🌐 Web query:

For peter-evans/create-pull-request v7, what are the default commit author and committer values, and does signoff: true generate a Signed-off-by line tied to that identity?

💡 Result:

In peter-evans/create-pull-request v7, the default values for commit author and committer are as follows: - Author: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com> [1][2] - Committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> [1][2] Regarding the signoff input, it is distinct from the sign-commits feature introduced in v7 [3][4]. The signoff input (if set to true) appends a Signed-off-by line to the commit message [1][5]. This line is tied to the identity defined by the commit author, as configured by the action's author input [1][2]. Please note that this is different from commit signature verification (enabled via sign-commits: true), which uses GPG or bot-generated signatures to verify the origin of a commit [3][4]. If you are using the signoff input, it will append the standard trailer (e.g., Signed-off-by: Display Name email@address.com) using the information provided in the author field [1].

Citations:

Ensure commit author and Signed-off-by footer match to satisfy DCO validation

Great addition of DCO support! Just to clarify how this works with peter-evans/create-pull-request@v7: when you don't explicitly set author and committer inputs, the action defaults to using the GitHub Actions trigger context (github.actor) as the commit author. This means the commit author will be whoever triggered the workflow, not cli-docs-bot.

Since your commit message manually includes Signed-off-by: cli-docs-bot <info@crossplane.io>, there's a mismatch—DCO typically validates that the Signed-off-by identity matches the commit author, so downstream checks may still fail.

To align these, consider explicitly configuring the author identity and letting the action handle the sign-off:

Suggested adjustment 
       - name: Create docs PR
         if: ${{ github.ref == 'refs/heads/main' && steps.find-changes.outputs.changed == 'true' }}
         uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
           path: ./docs
+          author: cli-docs-bot <info@crossplane.io>
+          committer: cli-docs-bot <info@crossplane.io>
+          signoff: true
           commit-message: |
             Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
-
-            Signed-off-by: cli-docs-bot <info@crossplane.io>
           title: Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
           branch: auto-update-cli-docs
           add-paths: content/cli/master/command-reference.md

This ensures the commit author, Signed-off-by footer, and DCO validation all align correctly.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
commit-message: |
Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
Signed-off-by: cli-docs-bot <info@crossplane.io>
title: 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>
signoff: true
commit-message: |
Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
title: Update master CLI reference docs for ${{ needs.build-artifacts.outputs.version }}
🤖 Prompt for 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.

In @.github/workflows/ci.yml around lines 263 - 267, The commit message includes
a hardcoded Signed-off-by footer for cli-docs-bot, but the
peter-evans/create-pull-request@v7 action is not explicitly configured with
author and committer inputs, causing it to default to the GitHub Actions trigger
context. This creates a mismatch that violates DCO validation. Add explicit
`author` and `committer` inputs to the create-pull-request action step, setting
both to "cli-docs-bot <info@crossplane.io>", and remove the manual Signed-off-by
line from the commit-message field to let the action handle the sign-off
automatically, ensuring the commit author and Signed-off-by footer match
exactly.

@jbw976 jbw976 Jun 16, 2026 •
edited
Loading

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.

this could be a good idea @adamwg ^ (if it's correct)

@coderabbitai coderabbitai Bot Jun 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

@tampakrap tampakrap Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

this suggestion is valid, the README of the gh action confirms it https://github.com/peter-evans/create-pull-request#action-inputs

@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.

Whoops, merged before addressing this 🤦‍♂️. I will fix it in a follow-up.

branch: cli-docs-${{ 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
# it makes sense to merge only the most recent.
branch: auto-update-cli-docs

@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.

since we'll be re-using the same branch, is there any additional config/settings we need to do to make sure it keeps getting synced/rebased to the latest in docs master?

@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.

The contents of the branch will be re-created each time the workflow runs by checking out the current docs master branch and running crossplane generate-docs. The create-pull-request action docs say it will do a force-push, so the branch should get updated to be based on the current master every time.

add-paths: content/cli/master/command-reference.md
Loading