docs(eng): document the merge-clearance escape hatches in the README - #60
Merged
Merged
Conversation
The hook table's merge-clearance row described `check` and `clear` but never mentioned the ways a blocked dimension can be waived. That gap predates this change (the CodeRabbit rate-limit backstop has been in since eng 2.3.0 and was never documented either), and eng 2.8.0's new --override-cr-failure made it worse: nothing tracked told a human the flag exists. Now the row names all of it: CI and CodeRabbit are hard, --skip-review and --skip-qa waive the human-judgment dimensions, a rate-limited CodeRabbit auto-satisfies on a current /eng:cr review, and a genuine CodeRabbit failure takes the explicit flag which also requires that review. Plus the point that ties them together: every waiver is recorded in the checklist, the --json verdict, the stamp evidence and the posted status description. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughExpanded ChangesMerge clearance documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
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
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
Post-ship docs sync for eng 2.8.0 (#59), caught by
/document-releaseduring close-out.eng/README.md's hook table describesmerge-clearance.shas "checkrenders the checklist;clearwrites the stamp and posts the status" and stops there. It never mentioned that dimensions can be waived at all. That gap is older than #59 (the CodeRabbit rate-limit backstop landed in eng 2.3.0 and was never documented), but #59 made it matter: it added an operator-facing flag,--override-cr-failure, that appeared in no tracked doc. The only place it existed was the script's ownusageoutput.The row now states the full contract:
--skip-review/--skip-qawaive the two human-judgment dimensions./eng:crreview backstops the head.--override-cr-failure, which also requires that current review, so the gate never loses both reviewers at once.--jsonverdict, the stamp evidence and the posted status description.QA
Docs-only: one line, one tracked file, no scripts touched and no behavior change. The bookkeeping fast lane applies (it auto-waives the
/eng:crstamp and the QA checklist for a docs-only diff while keeping CI and CodeRabbit hard), which is also why this PR opened without its own/qa:plan.Verified by reading the shipped
merge-clearance.shusageblock and blocker logic at9a1e724to confirm every claim in the new text matches the code as merged.Summary by CodeRabbit