Stack split across merge groups closes the pull request at the boundary instead of continuing it in the next group
还没有人认领这个 Issue。
评估
调研方向
从 gh stack merge 背后的实现及其对 merge queue 的处理入手,然后跟踪 merge group 删除分支时触发的 REST/GraphQL 更新。复现一个启用 delete_branch_on_merge 的五个 PR 的 stack;完成的标准是:边界 PR 保持打开状态并重新指向 stack base,或在不丢失 stack 的情况下继续进入下一个 group。
由索引模型根据 Issue 内容生成。
描述
Summary
When a stack is split across consecutive merge groups, the pull request at the
split boundary is closed instead of continuing in the next group. Its base
branch (the head branch of the last PR in the merged group) is deleted by the
merge, GitHub re-targets the PR one link up the chain — onto the base's base,
which the same merge also deleted — and then closes it because that branch no
longer exists.
The stack never finishes landing, and the closed PR cannot be recovered through
the API or the UI: each obvious route is refused by a different validation (see
Impact). Recovery required force-pushing two deleted refs back to the remote.
Observed twice in the same stack, ~50 minutes apart, with gh stack v0.1.0.
Pull requests are referred to below as PR A … PR E on branches a … e;
timings, error strings, configuration values and documentation quotes are
verbatim from the real occurrences.
Environment
gh stackv0.1.0- Base branch
mainuses a merge queue:
mergeMethod=SQUASH,mergingStrategy=ALLGREEN,
maximumEntriesToBuild=8,maximumEntriesToMerge=5,minimumEntriesToMerge=1 - Repository settings:
delete_branch_on_merge: true,
squash_merge_commit_message: PR_BODY - No ruleset on the base branch —
GET /repos/{owner}/{repo}/rules/branches/main
returns[], sorequire_last_push_approvalanddismiss_stale_reviews_on_push
are both off. This distinguishes this report from #174 and #323, where
invalidated latest-push approval is the stated mechanism. Every PR here kept
reviewDecision: APPROVEDthroughout, including across force-pushes. - All PRs
APPROVED,MERGEABLE, required checks green when enqueued. - Every pull request in the stack was in the queue and building concurrently
when the merge happened —added_to_merge_queueis recorded for all of them at
the same second, and none was ejected before the merge. The stack was not too
large for the group either: in the second occurrence it was 5 pull requests
againstmaximumEntriesToMerge=5, so the documented 50-percent buffer was not
even needed. Only the first three merged.
Reproduction
- Create a 5-PR stack:
main <- a (PR A) <- b (PR B) <- c (PR C) <- d (PR D) <- e (PR E). - Merge the whole stack (
gh stack merge --yes). All five enter the queue
together — every PR recordsadded_to_merge_queueat the same second — and
all five build concurrently (maximumEntriesToBuild=8). - The queue merges only
PR A,PR B,PR C, whilePR DandPR Eare
still in the queue.
Actual
T+0s PR A, PR B, PR C merged (all three, same second)
T+2s PR D base_ref_deleted
T+2s PR D closed
T+2s PR E removed_from_merge_queue (actor: github-merge-queue[bot])
PR D's base wasc. After the merge it readsb— the base of its base,
deleted in the same operation — and the PR is closed.PR Ebeing ejected is expected and documented; it stays open because its own
base branchdstill exists.- The remainder of the stack does not continue in a subsequent merge group. It
cannot: the PR at the boundary is closed. - Why the queue stopped after three is unexplained by any configuration value —
all five were enqueued and building, and five is within
maximumEntriesToMerge. Whatever the reason for the boundary, the failure
reported here is what happens at it.
The first occurrence was identical with an 8-PR stack: three merged, the fourth
closed 2 seconds later, the rest left open.
Expected
Three documentation statements describe what should happen, and the observed
behavior contradicts the first two:
A large stack may also split across consecutive merge groups: the merge queue
allows a merge group to exceed its configured maximum size by up to 50 percent
to keep a stack together, and any pull requests that don't fit continue in
subsequent groups until the full stack has landed.
— Troubleshooting stacked pull requests
Merge part of the stack by merging a mid-stack pull request. The pull requests
below it merge too, and the pull requests above stay open and automatically
re-target the stack's base branch.
— About stacked pull requests
Stacks are kept together in the merge queue. If a pull request is removed or
ejected from the queue, all pull requests above it in the stack are also
ejected and removed.
— Troubleshooting stacked pull requests (this part works as documented)
So the PR at a group boundary should either continue in the next group, or at
minimum stay open re-targeted to the stack's base branch. Re-targeting to
the immediate parent's base is only safe when that branch still exists, which it
never does when the stack is merged as a unit with delete_branch_on_merge
enabled.
Any of these would fix it: re-target survivors to the stack's base rather than
one link up; re-target before deleting merged head branches; or skip head-branch
deletion for a branch that is the base of an open stacked pull request.
Impact: the closed pull request cannot be recovered
Four recovery routes, each refused by a different validation:
PATCH /repos/{owner}/{repo}/pulls/{D} base=main state=open
422 Cannot change the base branch because the pull request is part of a stack.
PATCH /repos/{owner}/{repo}/pulls/{D} state=open
422 state cannot be changed. The b branch has been deleted.
# after `gh stack unstack <stack>` lifted the stack restriction:
PATCH /repos/{owner}/{repo}/pulls/{D} base=main state=open
422 Cannot change the base branch of a closed pull request.
# and where the head had been force-pushed after closing (e.g. by `gh stack sync`):
PATCH /repos/{owner}/{repo}/pulls/{D} state=open
422 state cannot be changed. The d branch was force-pushed or recreated.
Changing the base requires the PR to be open; reopening requires the base branch
to exist; and reopening also requires the head to be at the SHA recorded when the
PR closed. With the base branch deleted, there is no ordering of these calls that
succeeds.
Recovery that worked
git push origin <sha of b>:refs/heads/b— restore the deleted base branch.
The SHA survives only inrefs/pull/{B}/head.- Where the head had moved since closing, rewind it to the recorded
headRefOid(also recoverable fromrefs/pull/{D}/head). PATCH /pulls/{D} state=open— now permitted.gh stack unstack <stack>— required before the base can be changed.PATCH /pulls/{D} base=main.- Restore the real head, delete the scaffold branch, and
gh stack linkto
rebuild the stack.
A user who did not know the SHAs live in refs/pull/{n}/head would have to
abandon the pull request and open a new one, losing its review history.
Notes
gh stack merge --helpsays that under a merge queue the pull requests "are
added to the queue together but merge as the queue processes them, so they may
land in separate groups rather than all at once", while Merging stacked pull
requests describes the selected PR and everything below it landing "together
as a single operation". Both can be true, but withdelete_branch_on_merge
enabled the first has a consequence the docs don't mention: any group boundary
inside a stack closes the pull request at that boundary.gh stack unstack <stack>reported
⚠ Some pull requests are queued for merge or have auto-merge enabledwhile no
pull request had either — that is #372.gh stack view --jsonreported the closed pull request as"state": "OPEN",
so neitherviewnor--shortsurfaced the closure; only the REST/GraphQL API
showedCLOSED. Filing separately.
- 主要语言
- Go
- 星标
- 1.5k
- 派生
- 73
- 平均合并
- 1 天 8 小时
- 30 天内合并 PR
- 7
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
github/gh-stack 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
-
难度 1/5 1 小时以内 新手友好度 92/100
-
feature request topic: cli - general
难度 2/5 1-3 小时 新手友好度 68/100
-
feature request topic: auto-merge
难度 2/5 1-3 小时 新手友好度 68/100
-
bug topic: docs
难度 1/5 1 小时以内 新手友好度 68/100
相似的 Issue
-
textual definition
难度 1/5 1 小时以内 新手友好度 90/100
geneontology/go-ontology#32653 ·
-
难度 1/5 1 小时以内 新手友好度 75/100
-
needs design
难度 2/5 1-3 小时 新手友好度 75/100
-
Priority/High ready-for-agent Severity/Major Type/Bug
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 70/100