gitのsubmoduleについてまとめ

submoduleに関する忘備録です。

姫野秀徳

組み込みエンジニアとしてメーカー勤務10年。
第二種電工事士、基本情報技術者、Code.org認定教師。
microbitを用いた電子工作＆プログラミング教室を開校。
組み込み開発の実際を発信するyoutube活動も行う。

submoduleとは

GitのSubmoduleは、リポジトリ内に別のリポジトリをサブモジュールとして組み込むための機能です。

これにより、異なるプロジェクトやライブラリを簡単に取り込むことができます。

submoduleとして追加したいディレクトリに移動します。

そのディレクトリ内で以下のコマンドを実行

$ git submodule add <追加するリポジトリのSSH>

共同開発の場合や自身の開発が進んだ場合など、submoduleを更新することもあるかと思います。

この場合、まずsubmoduleが入ったディレクトリに移動します。

そして、submoduleをpullするなりadd, commitするなりして更新。ここは通常の処理と変わらないですね。

submoduleはこのあとの対応が必要で、親のリポジトリに戻ったらsubmoduleの更新分をcommitする必要があります。

submoduleをcommitしたことで１段上がっているので、そちらに向きを変えるイメージです。

プロジェクトA、プロジェクトBがあったとして、それぞれ同じリポジトリをsubmoduleとして組み込んだとします。

submoduleとして組み込んだリポジトリはプロジェクト内で独立しているので、プロジェクトAのsubmoduleを更新しても、プロジェクトBのsubmoduleは更新されないです。