Repository navigation
docs(release): SC2 game-day runbook (#503) #1234
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.
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
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
4589580
docs(release): SC2 game-day runbook (#503) + tie regression test to SC2
don-petry 604fd90
fix(reviews): address review comments [skip ci-relay]
donpetry-bot e70511f
chore: dev-lead update (review-changes) [skip ci-relay]
donpetry-bot 713f416
Merge branch 'main' into docs/sc2-game-day-503
don-petry 633dd56
chore: dev-lead update (review-changes) [skip ci-relay]
donpetry-bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # SC2 game-day — prove a broken `next` can't block its own fix | ||
|
|
||
| **Invariant (Safe Release SC2, epic #495 · story #503):** a broken in-development | ||
| version of an agentic workflow **cannot block the PR that fixes its own breakage.** | ||
| This is the circular-dependency failure the whole Safe Release strategy exists to | ||
| eliminate (`dev-lead`/`pr-review` build, review, and merge changes *to themselves*). | ||
|
|
||
| ## Why the invariant holds | ||
|
|
||
| Two independent mechanisms guarantee it; either alone is sufficient, and together | ||
| they are belt-and-suspenders: | ||
|
|
||
| 1. **Channel decoupling (structural).** New versions are exercised on `next`/`ring0` | ||
| while production self-review/dev **duty stays pinned to `stable`** | ||
| (`versioning.md`). A break in `next` therefore does not, by construction, take | ||
| out the gate that reviews the fix — the fix PR is still evaluated by the last | ||
| known-good `stable`. | ||
|
don-petry marked this conversation as resolved.
Resolved
|
||
|
|
||
| 2. **Break-glass (operational, #619).** For the residual case where a break *does* | ||
| reach the gate that must review its own fix — e.g. a bug in `compute_ci_status` | ||
| that marks the fix PR "failing" — a manual `FORCE_REVIEW` run (`@mention` / | ||
| `workflow_dispatch`) bypasses **every** soft gate, including the `ci-failing` | ||
|
don-petry marked this conversation as resolved.
Resolved
|
||
| gate: | ||
| - advisory-bot gate, `CHANGES_REQUESTED`, idempotency, and the review cap | ||
| (pre-existing), **and** | ||
| - the `ci-failing` gate (`scripts/review-one-pr.sh`, shipped in #1230). | ||
|
|
||
| `FORCE_REVIEW` is **manual-only** (the scheduled sweep dispatches | ||
| `force_review=false`), and GitHub's ruleset still blocks the merge on any | ||
| failing **required** check, so the break-glass only unblocks the | ||
| codeowner-approval gate — it cannot merge a genuinely-broken PR. | ||
|
|
||
| ## Automated regression guard | ||
|
|
||
| `tests/test_review_one_pr_force_ci_failing.bats` codifies mechanism (2): | ||
|
|
||
| - a **normal** run on failing CI still skips (`reason=ci-failing`, exit 100) — the | ||
| gate is not weakened for day-to-day operation; | ||
| - a **`FORCE_REVIEW=true`** run on failing CI **bypasses** the gate — the fix can | ||
| be reviewed and approved. | ||
|
don-petry marked this conversation as resolved.
Resolved
|
||
|
|
||
| If a future change re-couples the gate to its own fix, that test fails. | ||
|
|
||
| ## Running the game-day (operational drill) | ||
|
|
||
| Run this after any material change to the CI gate (`compute_ci_status`, | ||
| `review-one-pr.sh` skip logic) or the channel-pinning layout. | ||
|
|
||
| 1. **Break `next` deliberately.** On a scratch branch, introduce a change to the | ||
| `next`-channel review gate that marks all PRs as `ci-failing` (e.g. force | ||
| `compute_ci_status` to return `failing`). Promote it to `pr-review/next` only | ||
| (`cut-release.sh --channel pr-review/next …`), never `stable`. | ||
|
don-petry marked this conversation as resolved.
Resolved
don-petry marked this conversation as resolved.
Resolved
|
||
| 2. **Open the fix PR** that reverts/repairs the break, targeting `main`. | ||
| 3. **Confirm the block reproduces.** The unattended cascade skips the fix PR with | ||
| `reason=ci-failing` (the broken gate is reviewing its own fix). | ||
| 4. **Apply the break-glass.** `@mention` the review bot (or `workflow_dispatch` | ||
| the trigger with `force_review=true`) on the fix PR. Expect the | ||
|
don-petry marked this conversation as resolved.
Resolved
|
||
| `::warning::force-review: … bypassing the ci-failing gate (break-glass, #619)` line and an | ||
| approval from the reviewer identity. | ||
| 5. **Merge** (required checks green at the ruleset), which restores `next`. | ||
|
don-petry marked this conversation as resolved.
Resolved
|
||
| 6. **Restore** `pr-review/next` to the repaired version and record the drill | ||
| outcome on #503. | ||
|
don-petry marked this conversation as resolved.
Resolved
|
||
|
|
||
| **Pass criteria:** the fix PR is reviewed and approved via the break-glass within | ||
| one manual action, with no admin ruleset bypass and no manual file surgery — SC2 | ||
| and SC4 (one-action) both satisfied. | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.