blog.dopana

戻る

GitHubでスタックされたプルリクエストを操作する際、スタックの構造を変更する必要がよくあります - ブランチの並べ替え、結合、名前変更など。GitHub CLI拡張機能のgh stackは、これを簡単に行うための強力なツールを提供します。

問題#

スタックされたPRを使用して機能を開発する際、以下のような状況によく遭遇します:

  • ブランチをスタック内の上位または下位の位置に移動する必要がある
  • 2つのブランチを結合したい
  • PRを保持したままブランチをスタックから削除する必要がある
  • 既存のブランチの間に新しいブランチを挿入したい
  • ブランチの名前を変更して内容をより正確に反映させたい

複雑なgit rebaseとforce push操作を手動で行う代わりに、gh stackは専用のコマンドを提供します。

解決策#

GitHub CLIは、スタックを再構築するための2つの主要なアプローチを提供します:

1. gh stack modifyを使用する(推奨)#

このコマンドは、構造的な変更を行い、すべてを一度に適用できる対話型ターミナルUIを開きます。

gh stack modify
bash

TUIインターフェースは以下のキーバインディングをサポートします:

キーアクション説明
xDropブランチとそのコミットをスタックから削除
dFold downブランチを下のブランチに吸収(trunk方向)
uFold upブランチを上のブランチに吸収(trunkから離れる方向)
iInsert below下に新しい空のブランチを挿入(trunk方向)
IInsert above上に新しい空のブランチを挿入(trunkから離れる方向)
Shift+↓Move downブランチを下に移動(trunk方向)
Shift+↑Move upブランチを上に移動(trunkから離れる方向)
rRenameブランチの名前を変更(インラインプロンプトを開く)
zUndo最後のステージされたアクションを取り消し
Ctrl+SApplyすべての変更を適用

2. gh stack unstack + gh stack initを使用する#

より手動なアプローチですが、複雑な変更には柔軟です:

# 1. 現在のスタックを削除
gh stack unstack

# 2. 構造的な変更を手動で行う
git branch -m api-routes api-endpoints
git branch -d feature-removed

# 3. 新しい構造でスタックを再作成
gh stack init db-migrations api-endpoints frontend
bash

再構築ワークフロー#

スタックを再構築するワークフローは以下の通りです:

対話的手動いいえはい現在のスタック方法?gh stack modifygh stack unstackTUIを開くアクションを選択変更をステージ完了?Ctrl+Sで適用手動変更git branch -m/-dgh stack initカスケーディングrebasegh stack push再構築されたスタック

実用的な例#

例1:ブランチを上位に移動する#

下から上へのスタックがあるとします:

maindb-migrationsapi-routesfrontendtesting

testingをapi-routesの上に移動したい場合:

gh stack modify
# Shift+↑を使用してtestingを上に移動
# Ctrl+Sで適用
bash

結果:

maindb-migrationstestingapi-routesfrontend

例2:2つのブランチを結合する#

2つのブランチを結合すべきだと気づいた場合:

maindb-migrationsapi-routesapi-validationfrontend

api-validationをapi-routesにfoldする:

gh stack modify
# api-validationを選択し、d(fold down)を押す
# Ctrl+Sで適用
bash

結果:

maindb-migrationsapi-routes + validationfrontend

例3:新しいブランチを挿入する#

既存のブランチの間にレイヤーを追加する必要がある場合:

maindb-migrationsapi-routesfrontend

api-routesとfrontendの間にauth-middlewareを挿入:

gh stack modify
# カーソルをapi-routesに置く
# I(insert above)を押す
# 新しいブランチに名前を付ける
# Ctrl+Sで適用
bash

結果:

maindb-migrationsapi-routesauth-middlewarefrontend

カスケーディングrebaseプロセス#

gh stack modifyで変更を適用すると、以下のプロセスが発生します:

loop[各ブランチについて]gh stack modify変更をステージ(移動/fold/挿入)Ctrl-Sで適用必要に応じてブランチ名を変更必要に応じて新しいブランチを挿入カスケーディングrebase現在のブランチを下のブランチにrebaseRebase完了成功通知gh stack pushForce push with `\-\-force-with-lease`Push成功GitHubでスタックが更新されましたあなたgh stack modifyGitGitHub Remoteあなたgh stack modifyGitGitHub Remote

重要な注意点#

[!WARNING]

  • マージされたPRのブランチは変更できません
  • 構造的な変更(drop、fold、insert、rename)は同じセッションで混在できません
  • 安全のため常に--force-with-leaseでgh stack pushを使用してください
  • 大規模な再構築の前に重要なブランチをバックアップしてください

ベストプラクティス#

  • 現在のスタックを確認:変更前に常にgh stack viewを実行
  • TUIを使用:gh stack modifyは適用前に変更をプレビューできるため安全
  • ローカルでテスト:プッシュ前にrebaseが成功することを確認
  • コミュニケーション:主要なスタック構造変更についてチームに通知
  • バックアップ:重要なスタックのタグまたはブランチバックアップ

参考文献#