git submoduleについてのメモ 追加/削除/更新等

Gitのsubmoduleがいつもイマイチ良くわからなくなるので 自分なりのまとめ。

• レポジトリにsubmoduleの追加
• submoduleのあるレポジトリをcloneする
• submoduleの更新
• submoduleの削除
• ignore = dirty
• Submoduleのプロトコルの変更

レポジトリにsubmoduleの追加

git submodule addで追加。

$ git submodule add [email protected]:rcmdnk/evernote_mail.git ./submodules/evernote_mail

addすると.gitmoduleというファイルがまだ無い場合は作られ、その中に

[submodule "submodules/evernote_mail"]
    path = submodules/evernote_mail
    url = [email protected]:rcmdnk/evernote_mail.git

の様にsubmoduleのレポジトリのURLに加えて現レポジトリ内での位置情報が組み込まれます。

.git/configの方にも

[submodule "submodules/evernote_mail"]
    url = [email protected]:rcmdnk/evernote_mail.git

として情報が組み込まれます。

その後、通常の更新と同様

$ git add .gitmodules submodules/evernote_mail
$ # or git add -A
$ git commit -m "Added submodule:evernote_mail"
$ git push

とすれば、.gitmoduleファイル、及び、上記で指定した submoduleのディレクトリが親レポジトリへ登録されます。

GitHub上ではsubmoduleはそのレポジトリへのリンクになってみえます。

ref: https://github.com/rcmdnk/scripts/tree/master/submodules

submoduleのあるレポジトリをcloneする

この親レポジトリ(scripts)を他でcloneすると、 .gitmoduleだけにevernote_mailがあり、 evernote_mailディレクトリの中身は空のママ。 .git/configにも記述がないまま。

これを取ってくるためには

$ git submodule init
$ git submodule update

または

$ git submodule update --init

をします。initで.git/configへsubmoduleの情報を登録し、 updateで登録されてた状態にするためcloneしてきます(update --init==init+update)。

コマンドの最後に

$ git submodule update --init submodules/evernote_mail

の様にディレクトリ名を付ければそのsubmoduleだけに対して行います。

$ git clone --recursive [email protected]:rcmdnk/scripts

$ git submodule update --init --recursive

このupdateがいまいち何に対するアップデートなのか分からなくて混乱してしまいますが、

• 親レポジトリに登録されているsubmoduleのレポジトリ情報に基づきsubmoduleをアップデートする。

と言う意味でいいかと思います。

下に書くように、updateは決して

• submodule自身のレポジトリと比較して最新にアップデートする。

ではありません。 なので、何らかの変更をsubmodule内で直接する時は注意が必要で、 submoduleで変更した後、いきなり親ディレクトリで git submodule updateすると変更が全て上書きされて、 親ディレクトリに登録された状態、に戻されます。

submodule内で作業をした場合には、必ずadd/commitして、 さらに親ディレクトリからもaddしてsubmoduleの状態をきちんと更新しておく 必要があります。

submoduleの更新

submoduleのレポジトリが更新されてたりしても自動的には更新されません。

各submoduleの中で最新の状態にして、親レポジトリで再度git addする必要があります。

$ cd submodules/evernote_mail
$ git pull
$ cd -
$ git add submodules/evernote_mail
$ git commit -m "updated evernote_mail"

これで登録されているレポジトリ情報も最新のものになります。

また、submoduleを直接pullしたりするコマンドはないみたいですが、 foreachというコマンドがあって、これをすると全てのsubmoduleに対して同じコマンドを 打てるのでこれを使えば

$ git submodule foreach git pull

とすればOK。

また、親レポジトリをcloneした際に既にsubmoduleに更新がある場合、 submoduleがcloneされた後に、 以前のコミットの状態で無名ブランチ(detached HEAD)になってしまいます。

$ cd submodules/evernote_mail
$ git branch
* (detached from 7efd90a)
  master

なので、その状態で素直にgit pullすると

$ git submodule foreach git pull
Entering 'submodules/evernote_mail'
You are not currently on a branch. Please specify which
branch you want to merge with. See git-pull(1) for details.

    git pull <remote> <branch>

Stopping at 'submodules/evernote_mail'; script returned non-zero status.

の様なエラーが出てしまいます。 ので、もし、全てのsubmoduleでmasterブランチを追ってる場合は

$ git submodule update --init
$ git submodule foreach git checkout master

な感じでupdateした後に全てを現在のmaster状態にしてあげれば良いかと思います。 (取ってきたところでも積極的に更新、開発したい場合。)

submoduleで特定のブランチを使いたい場合にも、submoduleの中で

$ cd submodules/evernote_mail
$ git checkout test_branch

等としてsubmoduleの状態を変更して親レポジトリでadd&commitすれば このブランチがupdateした際に取ってこられるようになります。

submoduleの削除

$ submodule_dir=submodules/evernote_mail
$ git submodule deinit ${submodule_dir}
$ # git config --file .gitmodules --remove-section submodule.${submodule_dir} # not needed for the latest git?
$ git rm ${submodule_dir}

最初のdeinitでevernote_mailディレクトリ内を全て消して .git/configからも情報を消します。

$ git rm $d
fatal: Please, stage your changes to .gitmodules or stash them to proceed

$ git commit -m "removed evernote_mail"
$ git rm $d
rm 'submodules/evernote_mail'
warning: Could not find section in .gitmodules where path=submodules/evernote_mail
(-_-) $

次に、gitmodulesからも消してsubmoduleの登録を消します。

最後に空のディレクトリを消して終わりです。

もし、親レポジトリからは外したいがファイルは残しておきたい、と言う場合には

$ submodule_dir=submodules/evernote_mail
$ git config --remove-section submodule.$submodule_dir}
$ git config --file .gitmodules --remove-section submodule.${submodule_dir}
$ git rm --cached ${submodule_dir}

のように、最初にsubmodule deinitを使う変わりgit configで .git/configから削除だけして、 最後に--cachedオプションを付けることでファイルやディレクトリは残したまま 親レポジトリへの登録だけ外します。

$ git submodule add  [email protected]:rcmdnk/evernote_mail.git ./submodules/evernote_mail
A git directory for 'submodules/evernote_mail' is found locally with remote(s):
  origin        [email protected]:rcmdnk/evernote_mail.git
If you want to reuse this local git directory instead of cloning again from
  [email protected]:rcmdnk/evernote_mail.git
use the '--force' option. If the local git directory is not the correct repo
or you are unsure what this means choose another name with the '--name' option.

ignore = dirty

$ git diff
diff --git a/submodules/evernote_mail b/submodules/evernote_mail
--- a/submodules/evernote_mail
+++ b/submodules/evernote_mail
@@ -1 +1 @@
-Subproject commit 601bbca665de752c956a23b61e3e54dd16d62764
+Subproject commit 601bbca665de752c956a23b61e3e54dd16d62764-dirty

$ git config --file .gitmodules submodule.submodules/evernote_mail.ignore dirty

[submodule "submodules/evernote_mail"]
	path = submodules/evernote_mail
	url = [email protected]:rcmdnk/evernote_mail.git
	ignore = dirty

Submoduleのプロトコルの変更