chore(auto-approve): make review body self-explanatory#105
Open
chore(auto-approve): make review body self-explanatory#105
Conversation
the previous review body ("Auto-approved: trusted bot, CI green, no
merge conflicts.") restates what the approval UI already shows and
leaves a reader who lands on a random bot-approved PR with no path
to audit the rules that let the approval through.
this message shows up on PRs across every repo that calls the
shared workflow (vcluster-docs, vcluster, vcluster-pro,
loft-enterprise, hosted-platform, loft-prod...), so it needs to
work without any repo-specific context. linking to the README
section gives anyone reading the approval a one-click jump to the
eligibility criteria and source, regardless of which repo surfaced
the PR. the body scalar uses a YAML block with a paragraph break so
GitHub renders the link on its own line rather than collapsing the
whole thing into a run-on sentence.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replace the review body that
auto-approve-bot-prsleaves on approved PRs with something actually useful to someone auditing an approval.Before:
After:
Why
The old message just restated the approval status (already shown by GitHub's UI) and gave no pointer to the source of the rules. Because this action runs against PRs in every repo that wires up the reusable workflow (
vcluster-docs,vcluster,vcluster-pro,loft-enterprise,hosted-platform,loft-prod, ...), the body needs to stand on its own and point somewhere that anyone can audit without repo-specific knowledge. Linking directly to the README section gives exactly that.The value is a YAML block scalar with a paragraph break so GitHub's markdown renders the URL on its own line rather than collapsing the whole message into a single run-on sentence.
References
DEVOPS-714 (review-body cleanup surfaced during the auto-approve rollout)
Test plan
yaml.safe_load).