HOWTO · Git
Git リポジトリのサブディレクトリのクローン
このチュートリアルでは、Git リポジトリのサブディレクトリのクローンを作成します。
このページの内容
Git プロジェクト内の1つのディレクトリを中心に作業するには、sparse-checkout を使って作業ツリーに展開するパスを選択します。作業場所は元のリポジトリ内に保たれ、そのディレクトリだけを含む別のリポジトリが作成されるわけではありません。
sparse-checkoutでできること、できないこと
通常のクローンでは、リポジトリのファイルが作業ツリーにチェックアウトされます。Git の sparse-checkout を使うと、同じリポジトリとその履歴に紐づいたまま、作業ツリーに展開する追跡対象のパスを選べます。たとえば backend と documentation も含むプロジェクトで、主に frontend モジュールを扱う場合に便利です。
パスを選択しても、ダウンロード量が必ず小さくなるとは限りません。sparse-checkout が制御するのは作業ツリーであり、取得されるリポジトリデータの量はクローン時のオプションや Git の設定によって異なります。独自の履歴を持つ独立したプロジェクトが必要な場合は、元のプロジェクト側でそのモジュール用の別リポジトリを用意する必要があります。
sparse-checkoutを使ってリポジトリをクローンする
まず、インストール済みの Git が sparse-checkout コマンドを提供していることを確認します。たとえば git help -a で確認できます。以下のコマンドは、このインターフェースが使える場合にのみ実行してください。作業ツリーを展開せずにクローンし、その後 frontend を選択します。リポジトリの URL とディレクトリ名は自分の値に置き換えてください。以下の URL とパスは例です。
次の Bash 例は、単独で実行できる小さなローカルリポジトリを作成し、その frontend ディレクトリを選択します。
set -eu
work=$(mktemp -d)
trap 'rm -rf "$work"' EXIT
git init --quiet "$work/source"
git -C "$work/source" config user.name "Example User"
git -C "$work/source" config user.email "example@example.com"
mkdir -p "$work/source/frontend" "$work/source/backend"
printf 'app source\n' > "$work/source/frontend/app.txt"
printf 'service source\n' > "$work/source/backend/service.txt"
git -C "$work/source" add frontend backend
git -C "$work/source" commit -m "Add project modules" >/dev/null
branch=$(git -C "$work/source" branch --show-current)
git clone --no-checkout --branch "$branch" "$work/source" "$work/project" >/dev/null 2>&1
git -C "$work/project" sparse-checkout init --cone
git -C "$work/project" sparse-checkout set frontend
git -C "$work/project" sparse-checkout list
frontend
リモートプロジェクトの場合、対応する手順は git clone --no-checkout <repository-url> my_project、cd my_project、git sparse-checkout init --cone、git sparse-checkout set frontend の順です。この順序で実行してください。選択するパスはリポジトリのルートからの相対パスです。インストール済みの Git が sparse-checkout を提供していない場合は、代わりに git clone <repository-url> my_project を使うと、作業ツリー全体を取得できます。出力例の frontend は英語表記のまま表示されます。
選択するディレクトリを変更する
選択中のパスを backend と documentation に置き換えるには、リポジトリ内で git sparse-checkout set backend documentation を実行します。frontend を選択したまま別のディレクトリを追加するには、git sparse-checkout add backend を使います。cone モードはディレクトリの選択を想定しているため、個々のファイルではなくディレクトリのパスを指定してください。
リポジトリのルートからの相対パスを使い、追跡対象のパスと同じ綴り、大文字・小文字で指定します。選択後に期待したファイルが表示されない場合は、トップレベルの項目なら git ls-tree --name-only HEAD でパスを確認し、正しいディレクトリを設定してください。frontend/components のようにルートからのパスを指定すれば、ネストされたパスも選択できます。
チェックアウトを確認し、よくある問題に対処する
選択したパスを確認するには git sparse-checkout list を実行し、作業ツリーの状態を調べるには git status --short を実行します。git rev-parse --show-toplevel で意図したリポジトリ内にいることを確認してください。選択するディレクトリ名は、このルートを基準に解釈されます。
コマンドを利用できない場合、インストール済みの Git が sparse-checkout インターフェースに対応していない場合、またはリポジトリの運用上それを使えない場合は、通常のクローンを使ってください。ディレクトリを選択しているのに期待したファイルがない場合は、そのパスがチェックアウト済みのコミットに存在するか、綴りが正しいかを確認します。作業ツリーにすでにある未追跡ファイルは、選択範囲外のパスにあっても表示されることがあります。
詳細は、Git sparse-checkout のドキュメント、git clone のドキュメント、git help のドキュメントを参照してください。