Git Submodule管理項目子模組

標籤：ring   遠程服務   reset   groovy   move   塊代碼   ranch   執行   常用   

使用情境

當項目越來越龐大之後，不可避免的要拆分成多個子模組，我們希望各個子模組有獨立的版本管理，並且由專門的人去維護，這時候我們就要用到git的submodule功能。

常用命令

git clone <repository> --recursive 遞迴的方式複製整個項目git submodule add <repository> <path> 添加子模組git submodule init 初始化子模組git submodule update 更新子模組git submodule foreach git pull 拉取所有子模組

如何使用1. 建立帶子模組的版本庫

例如我們要建立如下結構的項目

project  |--moduleA  |--readme.txt

建立project版本庫，並提交readme.txt檔案

git init --bare project.gitgit clone project.git project1cd project1echo "This is a project." > readme.txtgit add .git commit -m "add readme.txt"git push origin mastercd ..

建立moduleA版本庫，並提交a.txt檔案

git init --bare moduleA.gitgit clone moduleA.git moduleA1cd moduleA1echo "This is a submodule." > a.txtgit add .git commit -m "add a.txt"git push origin mastercd ..

在project項目中引入子模組moduleA，並提交子模組資訊

cd project1git submodule add ../moduleA.git moduleAgit statusgit diffgit add .git commit -m "add submodule"git push origin mastercd ..

使用git status可以看到多了兩個需要提交的檔案，其中.gitmodules指定submodule的主要資訊，包括子模組的路徑和地址資訊，moduleA指定了子模組的commit id，使用git diff可以看到這兩項的內容。這裡需要指出父項目的git並不會記錄submodule的檔案變動，它是按照commit id指定submodule的git header，所以.gitmodules和moduleA這兩項是需要提交到父項目的遠程倉庫的。

On branch masterYour branch is up-to-date with ‘origin/master‘.Changes to be committed: (use "git reset HEAD <file>..." to unstage) new file: .gitmodules new file: moduleA

2. 複製帶子模組的版本庫

方法一，先clone父項目，再初始化submodule，最後更新submodule，初始化只需要做一次，之後每次只需要直接update就可以了，需要注意submodule預設是不在任何分支上的，它指向父項目儲存的submodule commit id。

git clone project.git project2cd project2git submodule initgit submodule updatecd ..

方法二，採用遞迴參數--recursive，需要注意同樣submodule預設是不在任何分支上的，它指向父項目儲存的submodule commit id。

git clone project.git project3 --recursive

3. 修改子模組

修改子模組之後只對子模組的版本庫產生影響，對父項目的版本庫不會產生任何影響，如果父項目需要用到最新的子模組代碼，我們需要更新父項目中submodule commit id，預設的我們使用git status就可以看到父項目中submodule commit id已經改變了，我們只需要再次提交就可以了。

cd project1/moduleAgit branchecho "This is a submodule." > b.txtgit add .git commit -m "add b.txt"git push origin mastercd ..git statusgit diffgit add .git commit -m "update submodule add b.txt"git push origin mastercd ..

4. 更新子模組

更新子模組的時候要注意子模組的分支預設不是master。

方法一，先pull父項目，然後執行git submodule update，注意moduleA的分支始終不是master。

cd project2git pullgit submodule updatecd ..

方法二，先進入子模組，然後切換到需要的分支，這裡是master分支，然後對子模組pull，這種方法會改變子模組的分支。

cd project3/moduleAgit checkout mastercd ..git submodule foreach git pullcd ..

5. 刪除子模組

網上有好多用的是下面這種方法

git rm --cached moduleArm -rf moduleArm .gitmodulesvim .git/config

刪除submodule相關的內容，例如下面的內容

[submodule "moduleA"]      url = /Users/nick/dev/nick-doc/testGitSubmodule/moduleA.git

然後提交到遠程伺服器

git add .git commit -m "remove submodule"

但是我自己本地實驗的時候，發現用下面的方式也可以，伺服器記錄的是.gitmodules和moduleA，本地只要用git的刪除命令刪除moduleA，再用git status查看狀態就會發現.gitmodules和moduleA這兩項都已經改變了，至於.git/config，仍會記錄submodule資訊，但是本地使用也沒發現有什麼影響，如果重新從伺服器複製則.git/config中不會有submodule資訊。

git rm moduleAgit statusgit commit -m "remove submodule"git push origin master

Git Submodule管理項目子模組