docs(runbook): warn about async stacked branch deletion - #495
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the branch-protection runbook to clarify that delete_branch_on_merge=false is a necessary baseline for ordinary PR merges, but not a complete safeguard when using GitHub’s asynchronous stacked-merge path, and it documents observed evidence and mitigation steps.
Changes:
- Reframes the
delete_branch_on_merge=falseguidance as a baseline (not an absolute safeguard) and points to a new caveat section. - Adds an “Asynchronous stacked-merge caveat” section documenting the observed
z-shell/zsh-lintincident and concrete pre/post-merge verification and recovery gates.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
runbooks/branch-protection.md:85
- The sentence repeats “dependent” twice (“retargeted dependent dependent PR #110”), which is redundant and slightly harder to read. Removing the extra “dependent” keeps the link text descriptive for accessibility while avoiding duplication.
`delete_branch_on_merge` was `false`. GitHub also retargeted dependent
[`dependent PR #110`](https://github.com/z-shell/zsh-lint/pull/110) from `next` to `main` and
placed it in immutable stack metadata. Treat this as evidence for that path,
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
runbooks/branch-protection.md:85
- Minor grammar/readability: the sentence reads a bit awkwardly without an article (“deleted persistent head branch
next”). Adding “the” improves clarity without changing meaning.
[`z-shell/zsh-lint#117`](https://github.com/z-shell/zsh-lint/pull/117), the
accepted asynchronous merge deleted persistent head branch `next` even though
`delete_branch_on_merge` was `false`. GitHub also retargeted
[`dependent PR #110`](https://github.com/z-shell/zsh-lint/pull/110) from `next` to `main` and
placed it in immutable stack metadata. Treat this as evidence for that path,
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
delete_branch_on_merge=falseis the required ordinary-mergebaseline, not an absolute safeguard for GitHub's asynchronous stacked merges
Verification
runbooks/branch-protection.mdgit diff --checkand U+2014 scanRelated evidence: z-shell/zsh-lint#117 and z-shell/zsh-lint#110.