Git のローカルリポジトリを Zip して送ったら、解凍先で Git の履歴を閲覧できない

Windows 上で Git によるバージョン管理を使っているとあるプログラムのソースコードの受け渡しの話。

説明が面倒なのでどのような事情か詳細を省くが、どのようにソースコードを変更していったかの履歴情報込みで、そのソースコード一式をメール添付で送信する必要が発生した。Git は分散型バージョン管理システムということで、ローカルの履歴情報はすべて .git サブフォルダ以下に収録されている。なので、その .git サブフォルダごと Zip 圧縮してメールに添付すれば、目的を達成することができる。

ただ今回は、バージョン管理というよりは、コードをどのように変更していったのかその履歴から学んでもらうような学習用コンテンツだったので、rebase、reset、cherrypick、squash を駆使して、履歴を整理した。そのためこのローカルリポジトリには、ブランチからは到達不可能なコミットとそのオブジェクトが含まれていることになる。せっかくなので、そのような不要な履歴情報はすべてきれいに削除された状態で Zip して送ろうと考え、以下のように reflog の全削除と prune による到達不可能なコミットの削除、および再圧縮を実施。

git reflog expire --expire=now --expire-unreachable=now --all

git gc --aggressive --prune=now

その上で当該フォルダを .git サブフォルダ込みで Windows エクスプローラーで Zip して送付した。

解凍先で履歴が表示できない

そのようにして作成した Zip ファイルだったのだが、これを受け取り解凍した側で、肝心の変更履歴が閲覧できない、との予期せぬ事態が発生。

git log

fatal: not a git repository (or any of the parent directories): .git

上記のエラーメッセージのとおり、そもそも解凍先フォルダが Git のローカルリポジトリとして見なされていないようなのである。

原因は Zip 内に .git/refs フォルダが存在しないこと

連絡を受けて、慌てて、Zip されたファイルの中身と、圧縮元のファイル・フォルダ一式とを目視で比較していったところ、Zip ファイルの中身には、.git/refs サブフォルダ以下が収録されていないことを発見。圧縮元側を確認すると、.git/refs/heads および .git/refs/tags というサブフォルダが実在しているのだが、いずれのサブフォルダも空のフォルダであった。

Zip ファイルに .git/refs サブフォルダが収録されていない以上の差異を見つけられなかったので、Zip ファイルを受け取った側に、手動で .git/refs サブフォルダを作ってもらったところ、

mkdir ./.git/refs

git log --oneline

57213e4 (HEAD -> main) Initial Commit

これでどうやら正しい Git ローカルリポジトリと認識されたようで、無事、履歴が表示されるようになった。

Windows のエクスプローラーによる Zip 圧縮機能の振る舞い

Windows のエクスプローラーでは空フォルダは Zip に圧縮できないという仕様であるのはうっすら知ってはいた。実際、一階層の空フォルダを Windows のエクスプローラーで Zip 圧縮しようとすると、「空のフォルダは Zip 圧縮できない」というメッセージが表示される。ところが今回のように、「サブフォルダの中に、空のサブフォルダがある」状態だと、このメッセージが表示されずにさくっと Zip 圧縮処理が完了してしまうようなのだ。そのため、そもそも .git/refs サブフォルダの必要性がわかっていたとしても、気づかずにその Zip ファイルをそのまま送ってしまったかもしれない。

ちなみに、今回のケースで .git/refs サブフォルダ以下にひとつもファイルが存在しなかったのは、"git gc" コマンドによる整理による結果である。commit や checkout 等、何かしら Git の操作をしたあとであれば、.git/refs/head/main などのファイルができあがっているはずで、その場合は Zip 圧縮～解凍しても、今回のような事態にはならないはずだ。