天天看點

git submodule 完整用法整理

版權聲明:本文為吳孔雲部落格原創文章,轉載請注明出處并帶上連結,謝謝。 https://blog.csdn.net/wkyseo/article/details/81589477

最近有個項目遇到有子子產品,遂整理下。。牛逼的人感覺看官網就行,像我這種菜鳥總是需要反複記憶,git官網連結戳此。

1.先來個官方的API

git submodule [--quiet] add [<options>] [--] <repository> [<path>]
git submodule [--quiet] status [--cached] [--recursive] [--] [<path>…​]
git submodule [--quiet] init [--] [<path>…​]
git submodule [--quiet] deinit [-f|--force] (--all|[--] <path>…​)
git submodule [--quiet] update [<options>] [--] [<path>…​]
git submodule [--quiet] summary [<options>] [--] [<path>…​]
git submodule [--quiet] foreach [--recursive] <command>
git submodule [--quiet] sync [--recursive] [--] [<path>…​]
git submodule [--quiet] absorbgitdirs [--] [<path>…​]           

複制

看完後其實也差不多明白了,比其他git指令多了個

submodule

關鍵字,先不看submodule指令,有submodule的倉庫在目前目錄會有個**.gitmodules**檔案。記錄path和url,如下。這裡表明你引用的多少個子子產品

[submodule "test"]
	path = test
	url = http://github.com/demo/test.git           

複制

還有一處改動在

vi .git/config

檢視,如下

[core]
        repositoryformatversion = 0
        filemode = false
        bare = false
        logallrefupdates = true
        symlinks = false
        ignorecase = true
        autocrlf=false
[remote "origin"]
        url = url....
        fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
        remote = origin
        merge = refs/heads/master
[submodule "ssl"]
        active = true
        url = url....           

複制

上面的所有的指令基本都基于此處兩個檔案的配置來生效的。

2.解析git指令

常用指令如下

git clone <repository> --recursive  //遞歸的方式克隆整個項目
git submodule add <repository> <path> //添加子子產品
git submodule init //初始化子子產品
git submodule update //更新子子產品
git submodule foreach git pull  //拉取所有子子產品           

複制

2.1建立帶子子產品的版本庫

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

project
  |--moduleA
  |--readme.txt           

複制

建立project版本庫,并送出readme.txt檔案

git init --bare project.git
git clone project.git 
cd project1
echo "This is a project." > readme.txt
git add *
git commit -m "add readme.txt"
git push origin master
cd ..           

複制

建立moduleA版本庫,并送出a.txt檔案

git init --bare moduleA.git
git clone moduleA.git 
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這兩項是需要送出到父項目的遠端倉庫的。

On branch master
Your 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.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           

複制

2.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           

複制

2.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           

複制

  1. 删除子子產品

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

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           

複制

3.問題

git submodule 完整用法整理

git submodule update

出現此問題,是因為終端用的不是windows自帶的cmd,用自帶的cmd打開執行此指令即可