チャプター ▾ 第2版

7.12 Gitツール - バンドル

バンドル

Gitデータをネットワーク経由で転送する一般的な方法(HTTP、SSHなど)はすでに説明しましたが、実はもうひとつ、あまり使われていないものの非常に便利な方法があります。

Gitはデータを単一のファイルに「バンドル」することができます。これはさまざまなシナリオで役立ちます。例えば、ネットワークがダウンしていて、同僚に作業内容を送りたい場合。セキュリティ上の理由で社外からローカルネットワークにアクセスできない場合。ワイヤレス/イーサネットカードが壊れてしまった場合。一時的に共有サーバにアクセスできない場合で、誰かに更新をメールで送りたいが、40個のコミットを`format-patch`経由で転送したくない場合などです。

ここで`git bundle`コマンドが役立ちます。`bundle`コマンドは、通常`git push`コマンドでネットワーク経由でプッシュされるすべてのものを、バイナリファイルにパッケージ化します。このファイルを誰かにメールで送ったり、USBドライブに入れたりして、別のリポジトリでアンバンドルすることができます。

簡単な例を見てみましょう。2つのコミットを持つリポジトリがあるとします。

$ git log
commit 9a466c572fe88b195efd356c3f2bbeccdb504102
Author: Scott Chacon <schacon@gmail.com>
Date:   Wed Mar 10 07:34:10 2010 -0800

    Second commit

commit b1ec3248f39900d2a406049d762aa68e9641be25
Author: Scott Chacon <schacon@gmail.com>
Date:   Wed Mar 10 07:34:01 2010 -0800

    First commit

そのリポジトリを誰かに送りたいが、プッシュするリポジトリにアクセスできない場合、または単に設定したくない場合、`git bundle create`でバンドルできます。

$ git bundle create repo.bundle HEAD master
Counting objects: 6, done.
Delta compression using up to 2 threads.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (6/6), 441 bytes, done.
Total 6 (delta 0), reused 0 (delta 0)

これで、リポジトリの`master`ブランチを再作成するために必要なすべてのデータを含む`repo.bundle`というファイルができました。`bundle`コマンドでは、含めたいすべての参照または特定のコミット範囲をリストする必要があります。これを別の場所でクローンするつもりなら、ここで行ったようにHEADも参照として追加すべきです。

この`repo.bundle`ファイルを誰かにメールで送ったり、USBドライブに入れて手渡ししたりできます。

一方、この`repo.bundle`ファイルが送られてきて、プロジェクトで作業したいとします。URLからクローンするのと同じように、このバイナリファイルからディレクトリにクローンできます。

$ git clone repo.bundle repo
Cloning into 'repo'...
...
$ cd repo
$ git log --oneline
9a466c5 Second commit
b1ec324 First commit

参照にHEADを含めない場合、`-b master`または含まれている任意のブランチを指定する必要があります。そうしないと、どのブランチをチェックアウトすればよいかわからなくなります。

さて、そこに3つのコミットを行い、新しいコミットをUSBスティックまたはメールでバンドルとして送り返したいとします。

$ git log --oneline
71b84da Last commit - second repo
c99cf5b Fourth commit - second repo
7011d3d Third commit - second repo
9a466c5 Second commit
b1ec324 First commit

まず、バンドルに含めるコミットの範囲を決定する必要があります。ネットワーク経由で転送する最小限のデータセットを自動的に判断してくれるネットワークプロトコルとは異なり、手動でこれを把握する必要があります。もちろん、同じことをしてリポジトリ全体をバンドルすることもできますし、それは機能しますが、違いだけをバンドルする方が良いでしょう。つまり、ローカルで作成した3つのコミットだけをバンドルします。

そのためには、差分を計算する必要があります。コミット範囲で説明したように、コミットの範囲はさまざまな方法で指定できます。元々クローンしたブランチにはなかった、`master`ブランチにある3つのコミットを取得するには、`origin/master..master`や`master ^origin/master`のような表現を使用できます。これは`log`コマンドでテストできます。

$ git log --oneline master ^origin/master
71b84da Last commit - second repo
c99cf5b Fourth commit - second repo
7011d3d Third commit - second repo

これでバンドルに含めたいコミットのリストができたので、それらをバンドルしてみましょう。`git bundle create`コマンドを使い、バンドルのファイル名と含めたいコミットの範囲を指定します。

$ git bundle create commits.bundle master ^9a466c5
Counting objects: 11, done.
Delta compression using up to 2 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (9/9), 775 bytes, done.
Total 9 (delta 0), reused 0 (delta 0)

これでディレクトリに`commits.bundle`ファイルができました。これをパートナーに送ると、彼女はそれを元のリポジトリにインポートできます。その間にさらに作業が進んでいたとしても問題ありません。

彼女がバンドルを受け取ったら、自分のリポジトリにインポートする前に、その内容を調べることができます。最初のコマンドは`bundle verify`コマンドで、ファイルが実際に有効なGitバンドルであること、そして適切に再構成するために必要なすべての祖先が存在することを確認します。

$ git bundle verify ../commits.bundle
The bundle contains 1 ref
71b84daaf49abed142a373b6e5c59a22dc6560dc refs/heads/master
The bundle requires these 1 ref
9a466c572fe88b195efd356c3f2bbeccdb504102 second commit
../commits.bundle is okay

もしバンドル作成者が3つのコミットすべてではなく、最後の2つのコミットだけのバンドルを作成した場合、必要な履歴が欠けているため、元のリポジトリはそれをインポートできません。その場合、`verify`コマンドは次のようになります。

$ git bundle verify ../commits-bad.bundle
error: Repository lacks these prerequisite commits:
error: 7011d3d8fc200abe0ad561c011c3852a4b7bbe95 Third commit - second repo

しかし、最初のバンドルは有効なので、そこからコミットをフェッチできます。バンドルに含まれていてインポートできるブランチを確認したい場合は、単にヘッドをリストするコマンドもあります。

$ git bundle list-heads ../commits.bundle
71b84daaf49abed142a373b6e5c59a22dc6560dc refs/heads/master

`verify`サブコマンドもヘッドを教えてくれます。要点は、何がプルできるかを確認することなので、このバンドルからコミットをインポートするために`fetch`または`pull`コマンドを使用できます。ここでは、バンドルの`master`ブランチを、自分のリポジトリ内の`other-master`という名前のブランチにフェッチします。

$ git fetch ../commits.bundle master:other-master
From ../commits.bundle
 * [new branch]      master     -> other-master

これで、`other-master`ブランチにインポートされたコミットと、その間に自分の`master`ブランチで行ったコミットの両方があることがわかります。

$ git log --oneline --decorate --graph --all
* 8255d41 (HEAD, master) Third commit - first repo
| * 71b84da (other-master) Last commit - second repo
| * c99cf5b Fourth commit - second repo
| * 7011d3d Third commit - second repo
|/
* 9a466c5 Second commit
* b1ec324 First commit

したがって、適切なネットワークや共有リポジトリがない場合に、共有やネットワークタイプの操作を行う上で`git bundle`は非常に役立ちます。

scroll-to-top