使用git subtree & submodule管理多個子項目

本文首發在segmentfault中

背景

最近工作中遇到了一個問題:隨著項目越來越多,很多項目依賴同一個模板或是配置文件想同一管理,又不想分開維護,所以只能互相引用,或是各自維護,導致了后續的很多麻煩。

場景一:?很多公司手機端和pc同時開發,引用同一套模板,或者通用的組件庫。

場景二:用gulp、webpack來打包,或是用node來開發會有一些通用的配置文件需要統一管理。

第一階段:gulp等自動化工具手動同步


這個是我們最初使用的方法,比如有兩個項目projectA和projectB,B項目依賴A項目中的一套模板。

問題1:開發中我們引用模塊的時候,B項目要經過很長的路徑引用才能引到A項目中的模板,這要求所有開發者本地文件路徑保持高度一致。

問題2:使用webpack打包壓縮靜態文件的時候,A、B兩個項目必須在同一個git分支,很容易搞亂。

問題3:修改完文件不能及時看到效果,還要手動同步一次。這點是開發中最致命的問題,做前端的都會有體會如果改了一個樣式或是一個模板要通過一個很長的操作路徑才能看到效果,是非常影響開發效率的。

結論:在用了幾個月之后,各種問題暴露出來,我們必須找新的辦法。

第二階段:使用Git subtree

網上調研了很多方法,例如[git submodule](http://git-scm.com/book/en/v1/Git-Tools-Submodules),第二階段最終選擇了subtree,一是官網已經不再推薦使用submodule了,二是subtree實在是太方便易用了。(后來和同事商量了下發現submodule還是有使用價值的,在第三階段中我們再分析。)

說到subtree易用,只需要2步就可以初始化好一個子項目:

第一步:添加遠程倉庫

語法:`git remote add -f <子倉庫名> <子倉庫地址>`

實例:`git remote add -f component git@xxx.git`

驗證:`git remote -v` 可以看到已經你添加成功了一個新的遠程倉庫叫 `component `

第二步:創建本地目錄

語法:`git subtree add --prefix=<子目錄名> <子倉庫名> <分支> --squash`

實例:`git subtree add --prefix=component component master --squash`

這時候會在本地新建一個叫 `component` 的文件夾,`--squash ` 會把subtree上的改動合并成一次commit

第三步:使用 ( pull & push )

pull:`git subtree pull --prefix=component component master --squash`

push:`git subtree push --prefix=component component master --squash`

注意:**必須在 `component` 的父級目錄執行**,使用起來還不是很方便。

第四步:更方便的使用

可以在 `package.json` 里面加script語句來執行,這樣在每個文件夾下都可以pull & push,強制統一,避免出錯。

第三階段:使用Git submodule

1. 添加:`git submodule add`

2. 添加后會在當前目錄下生成一個 `.gitmodules ` 的新文件,里面會記錄submodule的引用信息,在當前項目的位置以及倉庫的url。

3.? `git submodule foreach git pull` 這樣可以更新所有子模塊。

這里只介紹了最基本的submodule用法,實際在多個項目中更新和修改submodule還是很多坑的,可以參考這篇文章? [Git Submodule的坑]([http://blog.devtang.com/2013/05/08/git-submodule-issues/])。** 所以我們規定在項目中只能pull子模塊,修改的話只能到子模塊中去push。** 這樣避免了多人修改造成的沖突。

結論

1.在新員工加入團隊時:一次性clone項目,submodule可以一起clone出來,只需添加--recursive遞歸參數就可以了,而subtree并不行,只能手動添加,不過可以借助神器Yeoman(一個自動生成項目腳手架的工具)來實現。

2.subtree適合像配置文件這種需要跟著項目走的情況。

3.submodule適合在開發階段時引用,到了生產環境會被打包到指定文件內,而本身并不用跟著版本走的情況。

參考文章

1. 官網文檔:Git Tools - Subtree Merging

2. 使用GIT SUBTREE集成項目到子目錄

3. 用 Git Subtree 在多個 Git 項目間雙向同步子項目,附簡明使用手冊

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

推薦閱讀更多精彩內容

  • 開發中我們經常會遇到這樣的情況:項目越來越大,一些通用的模塊我們希望將他抽離出來作為單獨的項目,以便其他項目也可以...
    feil0n9wan9閱讀 20,114評論 0 24
  • 本文作者陳云峰,轉載請注明。 這篇文章記錄個人常用的一些命令,和記不住的一些命令,轉載了并不斷更新。 Git官網 ...
    陳云峰閱讀 2,836評論 0 24
  • 背景 項目A與項目B存在公用模塊,在項目A中修改Bug或增加新功能需要同步到項目B中,由于存在區別所以還不能完全c...
    Archerlly閱讀 21,018評論 3 14
  • 本片內容轉自CSDN http://blog.csdn.net/ithomer/article/details/7...
    五娃兒閱讀 4,953評論 2 88
  • 如下圖所示效果,可以使用表格實現,本文采用在CSS中實現。 標記如下: 在實例中,有3個div,每列一個div,每...
    陸lmj閱讀 336評論 0 0