Renaming a stacked branch with `git branch -m` strands the stack: metadata keeps the old name
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- git, go
調査の方向性
cmd/utils.go の現在のブランチに関するエラーから始め、internal/stack/stack.go の resolveStack、FindAllStacksForBranch、Stack.Contains を追ってください。git.BranchExists の使用箇所と internal/modify/apply.go のリネーム処理を確認し、issue で説明されている reflog ベースの修復も含めてください。外部でリネームされたブランチを診断し、stack 番号を必要とせずに修復または削除できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
gh stack matches the current branch against .git/gh-stack by exact string
(resolveStack → FindAllStacksForBranch → Stack.Contains, cmd/utils.go:395,
internal/stack/stack.go:241). Renaming a stacked branch with git branch -m is not
observed, so the stack file keeps pointing at a name that no longer exists and every
stack command bails out with the same generic message.
gh stack modify already renames a branch in git and in the stack file together
(internal/modify/apply.go:190-228, verified: both .git/gh-stack and the git branch are
updated), so the invariant is understood. This issue is about a rename performed outside
gh-stack, which is how most people rename a branch.
Related but distinct: #137 reaches the same stranded state through sync --prune
(branch deleted, stack entry left behind), and #193 is the same family of "git operations
performed outside gh-stack aren't observed".
Reproduction
Requires an origin remote, but the repository need not exist.
git init repro && cd repro
git commit --allow-empty -m initial
git remote add origin https://github.com/you/does-not-exist.git
git switch -c feat/test
git commit --allow-empty -m wip
gh stack init feat/test # ✓ Adopted 1 branch: main ← feat/test
gh stack view --short # ✓ works
git branch -m feat/test-1
gh stack view # ✗ broken from here on
gh stack init with no arguments errors with "interactive input required", so the branch
name is passed explicitly to keep the repro scriptable.
Observed
.git/gh-stack is byte-identical before and after the rename; it still records
"branch": "feat/test".
| Command | Output |
|---|---|
gh stack view |
✗ current branch "feat/test-1" is not part of a stack |
gh stack add feat/test-2 |
same |
gh stack unstack / unstack --local |
same |
gh stack checkout feat/test (old name) |
✗ failed to checkout feat/test: failed to run git: error: pathspec 'feat/test' did not match any file(s) known to git |
gh stack checkout feat/test-1 (new name) |
✗ no locally tracked stack found for "feat/test-1" |
gh stack unstack <n> --local would remove the entry, but a stack that has not been
submitted has no stack number (Number int \json:"number,omitempty"``,
internal/stack/stack.go:46), so it cannot be targeted:
$ gh stack unstack 1 --local
✗ stack #1 is not tracked locally
With no gh stack list (#150) and an interactive-only checkout picker, the ways out are
renaming the branch back (verified: this fully restores the stack) or editing
.git/gh-stack by hand.
Expected
-
Diagnose instead of denying. Before printing "is not part of a stack"
(cmd/utils.go:234-243), check whether a recorded stack references a branch that no
longer exists.git.BranchExistsis already used throughout (cmd/sync.go:413,
cmd/modify.go:315, …).checkoutshould also stop surfacing git's raw
pathspec ... did not matcherror. -
Leave an escape hatch. Removing or repairing a stack whose branches are missing
should not require a stack number — this is the part #137 also runs into. -
Offer to repair. git records the rename in the reflog:
feat/test-1@{0}: Branch: renamed refs/heads/feat/test to refs/heads/feat/test-1so the stack file can be updated after confirming with the user. Reflog entries expire,
so this complements 1 rather than replacing it.
I have a patch implementing 1 and 3 and will open a PR referencing this issue.
Environment
gh stackv0.1.0- macOS 24.6.0 (Darwin, arm64)
- 主要言語
- Go
- スター
- 1.5k
- フォーク
- 73
- 平均マージ
- 1日 8時間
- マージ済み PR(30日)
- 7
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
github/gh-stack の issue をすべて見る
似ている 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