Skip to content

Commit ace18c0

Browse files
committed
document admin bypass and auto-merge limitations
1 parent 7c27ea3 commit ace18c0

4 files changed

Lines changed: 16 additions & 12 deletions

File tree

docs/package-lock.json

Lines changed: 0 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/src/content/docs/faq.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,14 @@ If the stack is not linear (e.g., after changes were pushed to a lower branch),
152152

153153
Every PR in a stack must meet the same merge requirements as a PR targeting the stack base (e.g., `main`): required reviews, passing CI checks, CODEOWNER approvals, and a linear history. All PRs below it must also meet these requirements. See the [Checks, Rules & Requirements](#checks-rules--requirements) section above for details.
154154

155+
### Can an admin bypass merge requirements on a Stacked PR?
156+
157+
Not yet — admin bypass is coming soon, but currently unavailable for stacked PRs. Admins can't merge a stack before its requirements are met, so every PR in the stack must satisfy its branch protection rules and required checks before the stack can land.
158+
159+
### Can I enable auto-merge on a Stacked PR?
160+
161+
Not yet — auto-merge is coming soon, but currently unavailable for stacked PRs, for both direct merges and the merge queue. You can't set a PR in a stack to land automatically once its requirements are met. Until then, merge the stack (or the part you want to land) yourself once its PRs are ready.
162+
155163
### How does merging a stack of PRs differ from merging a regular PR?
156164

157165
Stacks merge from the bottom up. When you click merge on a PR in a stack, that PR and all unmerged PRs below it land on the base branch together; PRs above remain open, and the remaining stack is automatically rebased so the next PR targets your base branch directly. With a direct merge the group lands as a single atomic operation; through a merge queue the PRs enter the queue together and are evaluated individually, from the bottom up.

docs/src/content/docs/guides/ui.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ Before a PR in the stack can be merged, the following conditions must be met:
7777

7878
![Merge box for a stacked pull request](../../../assets/screenshots/stack-merge-box.png)
7979

80+
:::note[Admin bypass & auto-merge currently unsupported]
81+
**Admin bypass** and **auto-merge** are coming soon, but currently unavailable for stacked PRs. You can't enable auto-merge on a PR in a stack, and admins can't bypass the merge requirements to merge before they're met. This applies to both direct merges and the merge queue.
82+
:::
83+
8084
### Rebasing from the UI
8185

8286
When the stack is not linear (e.g., after changes were pushed to a lower branch, or after `main` has moved ahead), a **Rebase Stack** button appears in the merge box. Clicking it triggers a server-side cascading rebase that:

docs/src/content/docs/introduction/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ GitHub supports two merge methods:
6969

7070
In both methods, the resulting commit history is the same as if each PR had been merged individually, starting from the bottom.
7171

72+
:::note[Admin bypass & auto-merge currently unsupported]
73+
Admin bypass and auto-merge functionality are coming soon, but currently unavailable for stacked PR merges. A stack merge can only be triggered once all selected PRs meet their requirements. See the [FAQ](/gh-stack/faq/#can-an-admin-bypass-merge-requirements-on-a-stacked-pr) for details.
74+
:::
75+
7276
### Merge Methods
7377

7478
Stacks support all three merge methods:

0 commit comments

Comments
 (0)