ci: Make cli-docs-bot the author of docs update commits#121
Conversation
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>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe CI workflow updates the docs PR commit-message template to include an ChangesDocs PR author metadata
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 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 |
| 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> |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Oh wow, I completely missed the signoff option in the docs. Updated.
There was a problem hiding this comment.
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>
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:
./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.