HN 日本語サマリー

← 一覧へ戻る
プログラミング

Git worktree を使用して、面倒な並列開発を回避する

Parallel development without the headaches using Git worktree (barrd.dev)

46 pointsby oogali34 コメント

要約

Git の worktree 機能は、単一のリポジトリ履歴を共有しながら、それぞれ独自のディレクトリで複数のブランチを同時に作業できるようにする強力なツールです。これにより、ブランチ間の頻繁な切り替えや stashing の手間が省け、特に緊急の修正作業が発生した場合でも、コンテキストの切り替えを最小限に抑え、作業を整理しやすくなります。この記事では、worktree の基本的な使い方から、並列開発の具体的なシナリオ、そして worktree の管理方法までを解説しています。

全文翻訳

Git worktree を使って、面倒な並行開発を解消する

約 10 分で読める 1,916 語。

はじめに

最近、特に厄介なプロジェクトに取り組んでいる最中に、Git の [worktree](https://git-scm.com/docs/git-worktree) 機能に出会いました。これは、単一のリポジトリ履歴を共有しながら、それぞれ独自のディレクトリで複数のブランチを同時に作業できるツールです。

簡単な視覚化;

~/Herd/
├── my-project/          # メインのワークツリー、ブランチ `main`
│   └── .git/            # メインの Git ディレクトリ
├── my-project-feature/  # リンクされたワークツリー、ブランチ `feature/login-form`
└── my-project-hotfix/   # リンクされたワークツリー、ブランチ `hotfix/payment-bug`

上記のすべてのディレクトリは同じコミット履歴を共有し、それぞれが独自のワーキングディレクトリ状態を持っているにもかかわらず、同じ .git オブジェクトデータベースにリンクされています。

各ディレクトリは通常のチェックアウトのように動作し、ファイルを編集し、コミット、プッシュを通常通り行うことができますが、単一のワーキングツリーでのブランチの頻繁な切り替えを回避できます。

Git ブランチとワークツリーの違い

Git ロゴ Git バージョン管理ロゴが傾いた黒い正方形の中に分岐図として表示されている。

従来、複数のブランチで作業するということは、git checkout と git stash を多用し、常に作業場所を保存し、コンテキストを切り替え、重要なものを失っていないことを願うことでした。特に、本番環境のバグが作業の流れを中断した場合、迷子になりやすいです。git worktree を使用すると、任意のブランチ(既存または新規)に対して新しいワーキングディレクトリを追加し、ワークストリームを分離したままにできます。例として;

# 既存のブランチをワークツリーとして追加する
git worktree add ../my-project-feature feature-branch

# または、新しいブランチとワークツリーを一度に作成する
git worktree add -b new-feature ../my-project-new-feature

これにより、メインプロジェクトと同じレベルに新しいディレクトリが作成され、指定したブランチにチェックアウトされます。これで、メインのワーキングディレクトリに触れることなく、各ディレクトリで独立してファイルを編集、コミット、プッシュできます。

セットアップは次のようになります。

my-project/              # メインのワークツリー、ブランチ `main`
my-project-feature/      # `feature-branch` 用のワークツリー
my-project-new-feature/  # `new-feature` 用のワークツリー

重要な制限事項として、同じブランチを複数のワークツリーで同時にチェックアウトすることはできません。各ワークツリーは一意のブランチをチェックアウトする必要があります。実際には、これは「1 つのタスク、1 つのブランチ、1 つのディレクトリ」という整然としたマッピングを奨励し、精神的な方向感覚を保ちやすくします。

実用例:フィーチャーとホットフィックスの切り替え

現実的なシナリオとして、チェックアウト機能に取り組んでいる最中に、本番環境のバグが発生したとします。

初期レイアウト;

~/Herd/
└── shop/           # メインのワークツリー、ブランチ `main`
    └── .git/

フィーチャーワークツリーを作成します;

cd ~/Herd/shop
git worktree add -b feature/checkout ../shop-checkout

新しいレイアウト;

~/Herd/
├── shop/           # メインのワークツリー、ブランチ `main`
│   └── .git/
└── shop-checkout/  # リンクされたワークツリー、ブランチ `feature/checkout`

shop をクイックレビューのために main に置いたまま、shop-checkout でチェックアウトフィーチャーを簡単に開発できます。

本番環境のバグが発生、ホットフィックスワークツリーを作成
cd ~/Herd/shop
git worktree add -b hotfix/payment-fail ../shop-payment-hotfix

レイアウトは次のようになります。

~/Herd/
├── shop/                 # メインのワークツリー、ブランチ `main`
├── shop-checkout/        # フィーチャーワークツリー、`feature/checkout`
└── shop-payment-hotfix/  # ホットフィックスワークツリー、`hotfix/payment-fail`

この時点で、次のことが可能です。

  • shop-payment-hotfix ワークツリーで本番環境のバグを修正およびテストする。
  • shop-checkout ワークツリーで feature/checkout のイテレーションを続行する。
  • shop をマージやコードレビューのために main で空けておく。

ワークツリーを別のブランチにマージする方法

ワークツリーブランチからの変更のマージは、他の Git マージと同様ですが、各ブランチが独自のディレクトリに存在するため、コンテキストがより明確になります。以下は、フィーチャーブランチを main にマージする典型的なワークフローです。

  1. フィーチャーワークツリーで作業を完了し、変更をコミットします。
  2. メインのワークツリーディレクトリに切り替えます。
cd ../my-project && git checkout main
  1. フィーチャーブランチをマージします。
git merge feature-branch
  1. コンフリクトを解決し、プッシュします。

各ワークツリーは単一のブランチ専用であるため、ホットフィックスがフィーチャー作業を中断したときに、誤って間違ったブランチにコミットしたり、作業場所を失ったりすることははるかに困難になります…まあ、それは理論上の話です。😉

現在のワークツリーの確認方法

何かを削除またはクリーンアップする前に、Git が現在認識しているワークツリーを確認すると役立ちます。

git worktree list

例:

/Users/barrd/Herd/shop                 66c16256 [main]
/Users/barrd/Herd/shop-checkout        0c8ba118 [feature/checkout]
/Users/barrd/Herd/shop-payment-hotfix  a16e4be2 [hotfix/payment-fail]

これを次のようにマッピングできます。

[main]                → /home/user/Herd/shop
[feature/checkout]    → /home/user/Herd/shop-checkout
[hotfix/payment-fail] → /home/user/Herd/shop-payment-hotfix

これにより、どのブランチがチェックアウトされており、どこにあるかが明確になり、別のワークツリーに既にアタッチされているブランチを再利用しようとするのを避けるのに役立ちます。

ワークツリーの削除方法

ワークツリーが不要になったら、整理整頓するのが良い習慣です。安全に行うには、変更をコミットまたはスタッシュした後、次のコマンドを実行します。

git worktree remove ../my-project-feature

これは、クリーンなワークツリー(未コミットの変更や追跡されていないファイルがない状態)でのみ機能します(--force を渡さない限り)。また、メインのワークツリーを削除することはできません。

注意
ワークツリーの削除はワーキングディレクトリのみを削除し、ブランチ自体は削除しません。未コミットの作業を失わないように、削除する前に必ずそのワークツリーで git status を確認してください。

ステーブルなワークツリーの prune によるクリーンアップ

ワークツリーディレクトリを手動で削除した場合、Git はメインリポジトリの worktrees ディレクトリの下にメタデータを保持します。その場合、git worktree list は欠落しているとマークされたエントリを表示します。

これらのステイブルなエントリは、次のコマンドでクリーンアップできます。

git worktree prune

一定期間使用されていないエントリのみをクリーンアップするには、有効期限を追加できます。

git worktree prune --expire 7.days.ago

--expire now を使用すると、すべてのステイブルなワークツリーメタデータが即座に削除されます。これは、古い不要なディレクトリを頻繁に削除するローカル開発環境で役立ちます。

まとめ

これは v2.5(約 10 年前)から存在していましたが、私はこれまで使用したことがありませんでした…しかし、特に並行フィーチャーや緊急のホットフィックスを切り替える際に、私のワークフローを変革しました。すべての要素をコンパートメント化し、コンテキストスイッチを減らし、スタッシュがまれな例外になりました。

シンプルでシーケンシャルな作業には、従来のブランチングが依然として最善の方法ですが、同時に二つの場所にいたいと思ったことがあるなら、git worktree を試してみてください。

お気に入りのワークフローのバリエーションがあれば、ぜひご連絡ください。

// 記事の終わり

記事情報

関連記事 / ページ

[画像: Dave A.K.A. 'barrd' の画像]

Dave はブリストル在住のスコットランドからの移民で、20 年以上のウェブ開発経験があります。ギターを弾くこと、読書、SF を見ること、テクノロジーのいじくり回しが好きです。

Dave についてもっと読む