使用Git Submodule管理子模塊 【轉(zhuǎn)載】

轉(zhuǎn)載地址:https://segmentfault.com/a/1190000003076028

使用場(chǎng)景

基于公司的項(xiàng)目會(huì)越來越多搪桂,常常需要提取一個(gè)公共的類庫提供給多個(gè)項(xiàng)目使用,但是這個(gè)library怎么和git在一起方便管理呢甥厦?
我們需要解決下面幾個(gè)問題:

  • 如何在git項(xiàng)目中導(dǎo)入library庫?

  • library庫在其他的項(xiàng)目中被修改了可以更新到遠(yuǎn)程的代碼庫中?

  • 其他項(xiàng)目如何獲取到library庫最新的提交?

  • 如何在clone的時(shí)候能夠自動(dòng)導(dǎo)入library庫?

解決以上問題,可以考慮使用git的 Submodule來解決久橙。

什么是Submodule?

git Submodule 是一個(gè)很好的多項(xiàng)目使用共同類庫的工具茵肃,他允許類庫項(xiàng)目做為repository,子項(xiàng)目做為一個(gè)單獨(dú)的git項(xiàng)目存在父項(xiàng)目中,子項(xiàng)目可以有自己的獨(dú)立的commit辐烂,push遏插,pull。而父項(xiàng)目以Submodule的形式包含子項(xiàng)目纠修,父項(xiàng)目可以指定子項(xiàng)目header胳嘲,父項(xiàng)目中會(huì)的提交信息包含Submodule的信息,再clone父項(xiàng)目的時(shí)候可以把Submodule初始化扣草。

在項(xiàng)目中使用Submodule

使用git命令可以直接添加Submodule

git submodule add git@github.com:jjz/pod-library.git pod-library

使用 git status命令可以看到

git status

    On branch master
    Changes to be committed:

        new file:   .gitmodules
        new file:   pod-library

可以看到多了兩個(gè)需要提交的文件:.gitmodulespod-library
.gitmodules 內(nèi)容包含Submodule的主要信息了牛,指定reposirory,指定路徑:

    [submodule "pod-library"]
        path = pod-library
        url = git@github.com:jjz/pod-library.git

可以看到記錄了子項(xiàng)目的目錄和子項(xiàng)目的git地址信息颜屠。
pod-libray內(nèi)容只保護(hù)子項(xiàng)目的commit id,就能指定到對(duì)于的git header上,例如:

Subproject commit 4ac42d2f8b9ba0c2f0f2f2ec87ddbd529275fea5

4ac42d2f8b9ba0c2f0f2f2ec87ddbd529275fea5就是子項(xiàng)目的commit id鹰祸,父項(xiàng)目的git并不會(huì)記錄Submodule的文件變動(dòng)甫窟,它是按照commit git指定Submodulegit header

另外,這兩個(gè)文件都需要提交到父項(xiàng)目的git中蛙婴。

還可以這樣使用命令添加Submodule

git add .gitmodules pod-ibrary
git commit -m "pod-library submodule"
git submodule init

修改Submodule

首先需要確認(rèn)有對(duì)Submodule的commit權(quán)限粗井。
進(jìn)入Submodule目錄里面:

cd pod-library/

修改其中的一個(gè)文件看下文件的可以用git status查看變動(dòng):

git status

modified: pod-library/UseAFHTTP.h

提交Submodule的更改內(nèi)容:

git commit -a -m'test submodule'

然后push 到遠(yuǎn)程服務(wù)器:

git push

然后再回到父目錄,提交Submodule在父項(xiàng)目中的變動(dòng):

cd ..

git status
on branch master

modified: pod-library (new commits)

可以看到pod-library中已經(jīng)變更為Submodule最新的commit id:

Subproject commit 330417cf3fc1d2c42092b20506b0d296d90d0b5f

需要把Submodule的變動(dòng)信息推送到父項(xiàng)目的遠(yuǎn)程服務(wù)器

git commit -m'update submodule'

git push

這樣就把子模塊的變更信息以及子模塊的變更信息提交到遠(yuǎn)程服務(wù)器了,從遠(yuǎn)程服務(wù)器上更新下來的內(nèi)容就是最新提交的內(nèi)容了街图。

更新Submodule

更新Submodule有兩種方式:
在父項(xiàng)目的目錄下直接運(yùn)行

git submodule foreach git pull

在Submodule的目錄下面更新

>cd pod-library
git pull

可以看到在Submodule的目錄中,使用git和單獨(dú)的一個(gè)項(xiàng)目是一樣的,注意更新Submodule的時(shí)候如果有新的commit id產(chǎn)生浇衬,需要在父項(xiàng)目產(chǎn)生一個(gè)新的提交,pod-libray文件中的 Subproject commit會(huì)變?yōu)樽钚碌?code>commit id餐济。

clone Submodule

clone Submodule有兩種方式 一種是采用遞歸的方式clone整個(gè)項(xiàng)目耘擂,一種是clone父項(xiàng)目,再更新子項(xiàng)目絮姆。

  1. 采用遞歸參數(shù) --recursive

git clone git@github.com:jjz/pod-project.git --recursive

輸出結(jié)果:

    loning into 'pod-project'...
    remote: Counting objects: 57, done.
    remote: Compressing objects: 100% (45/45), done.
    remote: Total 57 (delta 13), reused 49 (delta 8), pack-reused 0
    Receiving objects: 100% (57/57), 18.79 KiB | 0 bytes/s, done.
    Resolving deltas: 100% (13/13), done.
    Checking connectivity... done.
    Submodule 'pod-library' (git@github.com:jjz/pod-library.git) registered for path 'pod-library'
    Cloning into 'pod-library'...
    remote: Counting objects: 34, done.
    remote: Compressing objects: 100% (25/25), done.
    remote: Total 34 (delta 8), reused 30 (delta 7), pack-reused 0
    Receiving objects: 100% (34/34), 12.95 KiB | 0 bytes/s, done.
    Resolving deltas: 100% (8/8), done.
    Checking connectivity... done.
    Submodule path 'pod-library': checked out '330417cf3fc1d2c

    42092b20506b0d296d90d0b5f'

可以看到init Submodule 會(huì)自動(dòng)被clone下來

  1. 第二種方法先clone父項(xiàng)目梳星,再初始化Submodule

git clone git@github.com:jjz/pod-project.git
cd pod-project

git submodule init

輸出:

    Submodule 'pod-library' (git@github.com:jjz/pod-library.git) 
    registered for path 'pod-library'

更新Submodule:

git submodule update

運(yùn)行結(jié)果:

  Cloning into 'pod-library'...
  remote: Counting objects: 34, done.
  remote: Compressing objects: 100% (25/25), done.
  remote: Total 34 (delta 8), reused 30 (delta 7), pack-reused 0
  Receiving objects: 100% (34/34), 12.95 KiB | 0 bytes/s, done.
  Resolving deltas: 100% (8/8), done.
  Checking connectivity... done.
  Submodule path 'pod-library': checked out '330417cf3fc1d2c42092b20506b0d296d90d0b5f'

刪除Submodule

git 并不支持直接刪除Submodule需要手動(dòng)刪除對(duì)應(yīng)的文件:

cd pod-project

git rm --cached pod-library
rm -rf pod-library
rm .gitmodules

更改git的配置文件config:
vim .git/config

可以看到Submodule的配置信息:

[submodule "pod-library"]
  url = git@github.com:jjz/pod-library.git

刪除submodule相關(guān)的內(nèi)容,然后提交到遠(yuǎn)程服務(wù)器:

git commit -a -m 'remove pod-library submodule'

代碼地址:
父項(xiàng)目:https://github.com/jjz/pod-pr...
子項(xiàng)目:https://github.com/jjz/pod-li...

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市滚朵,隨后出現(xiàn)的幾起案子冤灾,更是在濱河造成了極大的恐慌,老刑警劉巖辕近,帶你破解...
    沈念sama閱讀 219,490評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件韵吨,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡移宅,警方通過查閱死者的電腦和手機(jī)归粉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來漏峰,“玉大人糠悼,你說我怎么就攤上這事∏城牵” “怎么了倔喂?”我有些...
    開封第一講書人閱讀 165,830評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)靖苇。 經(jīng)常有香客問我席噩,道長(zhǎng),這世上最難降的妖魔是什么贤壁? 我笑而不...
    開封第一講書人閱讀 58,957評(píng)論 1 295
  • 正文 為了忘掉前任悼枢,我火速辦了婚禮,結(jié)果婚禮上脾拆,老公的妹妹穿的比我還像新娘馒索。我一直安慰自己莹妒,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,974評(píng)論 6 393
  • 文/花漫 我一把揭開白布绰上。 她就那樣靜靜地躺著旨怠,像睡著了一般。 火紅的嫁衣襯著肌膚如雪渔期。 梳的紋絲不亂的頭發(fā)上运吓,一...
    開封第一講書人閱讀 51,754評(píng)論 1 307
  • 那天渴邦,我揣著相機(jī)與錄音疯趟,去河邊找鬼。 笑死谋梭,一個(gè)胖子當(dāng)著我的面吹牛信峻,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播瓮床,決...
    沈念sama閱讀 40,464評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼盹舞,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了隘庄?” 一聲冷哼從身側(cè)響起踢步,我...
    開封第一講書人閱讀 39,357評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎丑掺,沒想到半個(gè)月后获印,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,847評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡街州,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,995評(píng)論 3 338
  • 正文 我和宋清朗相戀三年兼丰,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片唆缴。...
    茶點(diǎn)故事閱讀 40,137評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡鳍征,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出面徽,到底是詐尸還是另有隱情艳丛,我是刑警寧澤,帶...
    沈念sama閱讀 35,819評(píng)論 5 346
  • 正文 年R本政府宣布趟紊,位于F島的核電站质礼,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏织阳。R本人自食惡果不足惜眶蕉,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,482評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望唧躲。 院中可真熱鬧造挽,春花似錦碱璃、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至谐丢,卻和暖如春爽航,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背乾忱。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評(píng)論 1 272
  • 我被黑心中介騙來泰國(guó)打工讥珍, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人窄瘟。 一個(gè)月前我還...
    沈念sama閱讀 48,409評(píng)論 3 373
  • 正文 我出身青樓衷佃,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親蹄葱。 傳聞我的和親對(duì)象是個(gè)殘疾皇子氏义,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,086評(píng)論 2 355