背景
最近工作中遇到了一個問題:隨著項目越來越多,很多項目依賴同一個模板或是配置文件想同一管理,又不想分開維護,所以只能互相引用,或是各自維護,導致了后續的很多麻煩。
場景一:?很多公司手機端和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適合在開發階段時引用,到了生產環境會被打包到指定文件內,而本身并不用跟著版本走的情況。