`gh stack rebase` uses the wrong onto boundary for merged branches
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 84/100
Research direction
Start in internal/github/github.go and cmd/utils.go, then read cmd/rebase_test.go for the existing rebase boundary behavior. Run the rebase test and review the linked commit for the intended remote-versus-local SHA scenario. Done means the test covers local SHA A versus remote SHA B and gh stack rebase selects the remote merge point.
Written by the indexing model from the issue text.
Description
Problem: gh-stack needs to know "what was branch X's last commit right before it got merged" so it can skip replaying that history into upstack branches. Currently, it resolves this from the local clone instead of GitHub.
So, if branch X gets rebased elsewhere before merging, the local copy goes stale. That's normal and expected, however gh stack rebase fails to notice this and tries to replay from the wrong commit. This has led to spurious merge conflicts on files I didn't even touch, leading me to rebasing branches one-by-one or fixing the gh-stack state by hand (or with an agent).
Fix: I wrote a fix here. Full disclosure: I used Claude to write the fix but I manually reviewed and edited it afterwards.
I would open a PR for this but it's locked to contributors only.
Changes:
internal/github/github.go: Add one field,HeadRefOid, toPullRequest. This tracks the remote's record of the exact commit which was merged.cmd/utils.go:- When a PR is detected as merged, save its
HeadRefOidvalue. - When computing the rebase boundary, use
HeadRefOidinstead of getting the (possibly stale) local SHA throughgit.
- When a PR is detected as merged, save its
cmd/rebase_test.go: Add a test that fakes the problem scenario ("local has SHA A, but remote has SHA B (the real merge point)" and checks the tool picks B. This test fails without the above fixes, and passes with them.
Net effect: The onto boundary now comes from remote / GitHub (can't go stale) instead of local, eliminating confusing rebase conflicts due to a misconfigured rebase.
- Dominant language
- Go
- Stars
- 1.5k
- Forks
- 73
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 7
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/gh-stack
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
feature request topic: cli - general
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
feature request topic: auto-merge
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
bug topic: docs
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Similar issues
-
textual definition
Difficulty 1/5 Under an hour Newbie friendliness 90/100
geneontology/go-ontology#32653 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
needs design
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Priority/High ready-for-agent Severity/Major Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100