使用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阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容

  • 开发中我们经常会遇到这样的情况:项目越来越大,一些通用的模块我们希望将他抽离出来作为单独的项目,以便其他项目也可以...
    feil0n9wan9阅读 19,860评论 0 24
  • 本文作者陈云峰,转载请注明。 这篇文章记录个人常用的一些命令,和记不住的一些命令,转载了并不断更新。 Git官网 ...
    陳云峰阅读 2,803评论 0 24
  • 背景 项目A与项目B存在公用模块,在项目A中修改Bug或增加新功能需要同步到项目B中,由于存在区别所以还不能完全c...
    Archerlly阅读 20,932评论 3 14
  • 本片内容转自CSDN http://blog.csdn.net/ithomer/article/details/7...
    五娃儿阅读 4,911评论 2 88
  • 如下图所示效果,可以使用表格实现,本文采用在CSS中实现。 标记如下: 在实例中,有3个div,每列一个div,每...
    陆lmj阅读 322评论 0 0