Git Submodule管理專案子模組

2022-07-01 12:15:14 字數 3515 閱讀 6011

使用場景

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

常用命令

git clone --recursive 遞迴的方式轉殖整個專案

git submodule add 新增子模組

git submodule init 初始化子模組

git submodule update 更新子模組

git submodule foreach git pull 拉取所有子模組

如何使用

1. 建立帶子模組的版本庫

例如我們要建立如下結構的專案

project

|--modulea

|--readme.txt

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

git init --bare project.git

git clone project.git project1

cd project1

echo "this is a project." > readme.txt

git add .

git commit -m "add readme.txt"

git push origin master

建立modulea版本庫,並提交a.txt檔案

git init --bare modulea.git

git clone modulea.git modulea1

cd modulea1

echo "this is a submodule." > a.txt

git add .

git commit -m "add a.txt"

git push origin master

在project專案中引入子模組modulea,並提交子模組資訊

cd project1

git submodule add ../modulea.git modulea

git status

git diff

git add .

git commit -m "add submodule"

git push origin master

使用git status可以看到多了兩個需要提交的檔案,其中.gitmodules指定submodule的主要資訊,包括子模組的路徑和位址資訊,modulea指定了子模組的commit id,使用git diff可以看到這兩項的內容。

這裡需要指出父專案的git並不會記錄submodule的檔案變動,它是按照commit id指定submodule的git header,所以.gitmodules和modulea這兩項是需要提交到父專案的遠端倉庫的。

2. 轉殖帶子模組的版本庫

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

git clone project.git project2

cd project2

git submodule init

git submodule update

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

git clone project.git project3 --recursive
3. 修改子模組

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

cd project1/modulea

git branch

echo "this is a submodule." > b.txt

git add .

git commit -m "add b.txt"

git push origin master

cd ..

git status

git diff

git add .

git commit -m "update submodule add b.txt"

git push origin master

4. 更新子模組

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

方法一,先pull父專案,然後執行git submodule update,注意modulea的分支始終不是master。

cd project2

git pull

git submodule update

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

cd project3/modulea

git checkout master

cd ..

git submodule foreach git pull

5. 刪除子模組

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

git rm --cached modulea

rm -rf modulea

rm .gitmodules

vim .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 modulea

git status

git commit -m "remove submodule"

git push origin master

更多參考

Git Submodule 管理專案子模組

1 新增乙個子模組 git submodule add 子模組位址 自定義到當前工程的路徑 git commit git push 2 轉殖 更新帶子模組的工程 2.1 方法一 git clone 工程位址,進入工程後 git submodule init init 操作只需要在剛clone下來時執...

Git Submodule管理專案子模組

當專案越來越龐大之後,不可避免的要拆分成多個子模組,我們希望各個子模組有獨立的版本管理,並且由專門的人去維護,這時候我們就要用到git的submodule功能。git clone recursive 遞迴的方式轉殖整個專案 git submodule add 新增子模組 git submodule ...

git submodule來管理獨立git子目錄

在軟體開發過程中,通常我們會遇到有一些通用的部分希望抽取出來做成乙個公共庫的情況,比如安卓和ios都通用的h5頁面。而公共 庫的版本管理是個麻煩的事情。幸運的是,萬能的git有個叫子模組 git submodule 的命令完美地幫我們解決了這個問題。為當前工程新增submodule,命令如下 git...