[docs] Harden OB1 PR Gate: add ready_for_review trigger + branch protection instructions#1
Merged
Merged
Conversation
…tection instructions
- Add ready_for_review to the pull_request event types so draft PRs
re-run the gate when marked ready (previously only opened/synchronize/
reopened were covered)
- Replace vague recommendation comment with step-by-step branch
protection setup instructions, referencing the exact job name
('OB1 Review') that must be added as a required status check
The gate already blocks merge on failure: line 671 exits with code 1
when any of the 15 review checks fail. This change ensures the
workflow also runs when a draft PR transitions to ready-for-review,
closing a coverage gap.
|
Hey @Humestone — welcome to Open Brain Source! 👋 Thanks for submitting your first PR. The automated review will run shortly and check things like metadata, folder structure, and README completeness. If anything needs fixing, the review comment will tell you exactly what. Once the automated checks pass, a human admin will review for quality and clarity. Expect a response within a few days. If you have questions, check out CONTRIBUTING.md or open an issue. |
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
2 participants
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.
What
Two small improvements to .github/workflows/ob1-gate.yml:
1. Add ready_for_review event type
Draft PRs that transition to ready for review now re-trigger the gate. Previously only opened, synchronize, and reopened were covered, so a draft PR could skip the gate when marked ready.
2. Step-by-step branch protection instructions
Replaces the vague recommendation comment with exact steps referencing the job name (OB1 Review) that must be added as a required status check.
Current blocking evidence
The gate already blocks merge on failure:
To guarantee merge blocking, the admin must mark OB1 Review as a required status check in branch protection settings.
Admin action needed
If not already done, enable branch protection on main and add OB1 Review as a required status check (see the step-by-step in the updated comment).