【Git系列】git submodule-單項目多倉庫管理方案

1、基本介紹:

  • 當項目比較大的時候便于復用,或者多個項目共用module。這個時候需要抽取項目公共模塊,而且現在基本是使用git作為版本控制工具,這樣就變成App Project 有多個module,每個module都是一個獨立的git repository。而且我們希望單個的module都可以獨立維護,可以更方便查看和隨時隨地同步更新。
  • 為了達成這樣的目的我們可以使用git-submodule、git-repogitslave 、git-subtree
  • git-repo更適合管理比較大、module比較多、module會經常變更的項目,Android源碼就是采用這種方式管理。如果module比較少的情況,使用git-submodule完全夠用。

2、使用步驟:

  1. 進入到主項目根目錄中輸入命令
    • git submodule add <子module的git地址> : 從遠程倉庫將子module導入到該項目中,這時候會自動生成.gitmodules文件
    • git submodule add <子module的git地址> <主項目內的文件夾>: 從遠程倉庫將子module導入到該項目中的特定文件夾中。
    • git submodule init:初始化本地.gitmodules文件。
    • git submodule update:在父項目中更新子module的修改。
    • git submodule foreach git pull:拉取所有子模塊。
    • git submodule foreach git submodule update:如果你的submodule又依賴了submodule,可以使用git submodule foreach命令來實現一次性全更新。
    • git clone --recurse-submodules <主項目倉庫地址>:獲取主項目和所有子項目源碼【git pull <主項目倉庫地址>的時候不會同時獲取submodules的源碼】。
  2. 進入到子module目錄中輸入命令
    • 走正常的git add、git commit、git push流程。

3、注意點:

3.1、更新 submodule 的坑:

  • 在父項目中git pull只會更新父項目中的代碼,并不會更新子module項目中的代碼,這時忘記了調用 git submodule update,那么git push極有可能再次把舊的 submodule 依賴信息提交上去。
  • git pull 之后,立即執行 git status, 如果發現 submodule 有修改,立即執行 git submodule update
  • 如果你的 submodule 又依賴了 submodule,那么很可能你需要在 git pullgit submodule update 之后,再分別到每個 submodule 中再執行一次 git submodule update,這里可以使用 git submodule foreach git submodule update命令來實現。

3.2、修改 submodule 的坑:

  • 默認 git submodule update 并不會將 submodule 切到任何 branch,所以,默認下 submodule 的 HEAD 是處于游離狀態的 (‘detached HEAD’ state)。所以在修改前,記得一定要用 git checkout master 將當前的 submodule 分支切換到 master,然后才能做修改和提交。
  • 如果你不慎忘記切換到 master 分支,又做了提交,可以用 cherry-pick 命令挽救。具體做法如下:
  • git checkout master 將 HEAD 從游離狀態切換到 master 分支 , 這時候,git 會報 Warning 說有一個提交沒有在 branch 上,記住這個提交的 change-id(假如 change-id 為 aaaa)。
  • git cherry-pick aaaa 來將剛剛的提交作用在 master 分支上。
  • git push 將更新提交到遠程版本庫中。

3.3、刪除 submodule 的坑:

  • 直接刪除子模塊并不能完全刪除,再次添加的時候會報錯'<submodule子項目名字>' already exists in the index.
  • 用以下命令可以完全刪除submodule:
    git rm --cached <submodule子項目名字>
    rm -rf <submodule子項目名字>

參考:http://blog.devtang.com/2013/05/08/git-submodule-issues/

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,461評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,538評論 3 417
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,423評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,991評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,761評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,207評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,268評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,419評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,959評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,653評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,901評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,678評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,978評論 2 374

推薦閱讀更多精彩內容