🙆

Git Submodulesの使い方

2024/10/31に公開

submodulesとは

gitを使用してプロジェクトを管理しているときに，ほかのプロジェクトを取り込みたい場合があります．

そのようなときに使用できるのがSubmodulesです．

Submodulesを使用することで，あるGitリポジトリを別のGitリポジトリのサブディレクトリとして扱うことができます．

特定のバージョンの外部プロジェクトを安全に参照しつつ管理できるというメリットがあります．

submoduleを追加するには，以下のコマンドを実行します．

git submodule add <url> <path>

<url>には追加したいリポジトリのURLを指定し，
<path>には追加したいディレクトリ名を指定します．
<path>が空欄の場合は，追加するリポジトリ名がそのままディレクトリ名になります．

このコマンドを実行すると.gitmodulesというファイルが作成されます．
このファイルにはsubmoduleの情報が記載されています．

submoduleは特定のコミットを指し示すようになっています．

submoduleを含むリポジトリをcloneするには，以下のコマンドを実行します．

git clone --recurse-submodules <url>

--recurse-submodulesオプションをつけることで，submoduleも一緒にcloneされます．

--recurse-submodulesオプションをつけずにcloneした場合は，

git submodule init
git submodule update

を実行することでsubmoduleを取得することができます．

submoduleの更新を行うには，submoduleのディレクトリに移動し，以下のコマンドを実行します．(submoduleのmainブランチの内容を取得する場合)

git fetch
git merge origin/main

または，submoduleのディレクトリに移動しなくても以下のコマンドを実行することで更新ができます．

git submodule update --remote

デフォルトでは，リモートsubmoduleリポジトリのdefault branchの内容が取得されます．

これはすべてのsubmoduleを更新するため，特定のsubmoduleのみを更新したい場合は以下のコマンドを実行します．

git submodule update --remote <path>

<path>には更新したいsubmoduleのディレクトリ名を指定します．

誰かがsubmoduleが指し示すコミットを更新した場合，git pullを実行するだけではsubmoduleの更新があることのみが分かり，submoduleのファイル自体の更新は行われません．

submoduleを最新の状態にするには，以下のコマンドを実行します．

git submodule update --init --recursive

--initと--recursiveが必要ない場合もありますが，一応つけておくと安心です．

今回はsubmoduleの簡単な使い方について説明しました．