「Gitリポジトリのサブディレクトリのみをクローンする方法」の日本語解説

Gitは、ソフトウェア開発におけるバージョン管理システムです。リポジトリは、プロジェクトのファイルや履歴を保存する場所です。サブディレクトリは、リポジトリ内のフォルダです。

サブディレクトリのみをクローンするとは、リポジトリ全体ではなく、その中の特定のフォルダを複製することです。

方法:

2. クローンしたいリポジトリのURLを取得する

3. ターミナルで以下のコマンドを実行する:

   git clone --depth 1 --no-checkout <リポジトリのURL> <サブディレクトリ名>
   

   • --depth 1は、履歴の最新コミットのみをクローンするオプションです。
   • --no-checkoutは、クローンしたリポジトリのワーキングコピーを作成しないオプションです。

4. クローンしたサブディレクトリに移動する:

   cd <サブディレクトリ名>
   

5. 必要に応じて、ワーキングコピーを作成する:

   git checkout -b <ブランチ名>
   

例:

git clone --depth 1 --no-checkout https://github.com/example/project.git my-subdirectory
cd my-subdirectory
git checkout -b working

これにより、projectリポジトリのmy-subdirectoryフォルダのみをクローンし、workingというブランチを作成します。

注意:

• サブディレクトリ自体はリポジトリではありません。そのため、直接コミットやプッシュを行うことはできません。
• サブディレクトリを独立したリポジトリにする場合は、git subtreeコマンドを使用できます。

Gitサブディレクトリをクローンする際のコード例解説

git clone --depth 1 --no-checkout を使った方法

git clone --depth 1 --no-checkout https://github.com/example/project.git my-subdirectory

• --depth 1: リポジトリの履歴を1コミット分だけ取得します。これにより、クローンするデータ量が大幅に削減されます。
• --no-checkout: ワークツリーを作成しません。つまり、すぐにファイルの編集や変更を開始することはできません。
• https://github.com/example/project.git: クローン元のGitリポジトリのURLです。
• my-subdirectory: ローカルに作成されるディレクトリ名です。このディレクトリの中に、指定したサブディレクトリの内容がコピーされます。

このコマンドを実行すると、projectリポジトリのルートから見たmy-subdirectoryというディレクトリが、ローカルのmy-subdirectoryディレクトリにコピーされます。

sparse-checkout を使った方法

git clone https://github.com/example/project.git
cd project
git config core.sparseCheckout true
echo "my-subdirectory" >> .git/info/sparse-checkout
git pull

• git config core.sparseCheckout true: sparse-checkout機能を有効にします。
• echo "my-subdirectory" >> .git/info/sparse-checkout: .git/info/sparse-checkoutファイルに、クローンしたいサブディレクトリのパスを記述します。
• git pull: リモートリポジトリから変更をフェッチし、ワークツリーに反映します。

この方法は、一度リポジトリ全体をクローンした後、必要なサブディレクトリだけをワークツリーに表示させる方法です。

各方法の比較

Gitサブディレクトリをクローンする代替方法

git subtree を利用する方法

git subtree は、既存のリポジトリのサブディレクトリを、別のリポジトリとして管理するための機能です。

メリット:

• サブディレクトリを独立したリポジトリとして扱うことができる。
• サブディレクトリへのコミットを、親リポジトリとは別に管理できる。

• 設定がやや複雑。
• git subtree コマンドの操作に慣れる必要がある。

手順:

1. メインリポジトリをクローン:

   git clone https://github.com/example/project.git
   

2. サブディレクトリを別のリポジトリとして追加:

   git subtree add --prefix=my-subdirectory https://github.com/example/submodule.git main
   

   • --prefix=my-subdirectory: サブディレクトリのパスを指定します。
   • https://github.com/example/submodule.git: サブモジュールとして追加するリポジトリのURLを指定します。
   • main: マージするブランチを指定します。

3. 変更をコミット:

   git commit -m "Add submodule"
   

サブモジュールを利用する方法

サブモジュールは、Gitリポジトリの中に別のGitリポジトリを含めることができる機能です。

• サブモジュールは独立したリポジトリとして管理できる。
• サブモジュールを更新する際に、親リポジトリの履歴を汚染しない。

• サブモジュールの管理に手間がかかる。

1. サブモジュールを追加:

   git submodule add https://github.com/example/submodule.git my-subdirectory
   

git archive を利用する方法（アーカイブ作成）

git archive は、リポジトリの特定のコミットやツリーをアーカイブファイルとして出力するコマンドです。

• シンプルな操作でアーカイブを作成できる。

• アーカイブファイルはGitリポジトリではないため、バージョン管理ができない。
• 更新する際に、再度アーカイブを作成する必要がある。

1. アーカイブを作成:

   git archive --format=zip --output=my-subdirectory.zip HEAD:my-subdirectory
   

2. アーカイブを解凍:

   unzip my-subdirectory.zip