Git Subtree的使用

背景

项目A与项目B存在公用模块,在项目A中修改Bug或增加新功能需要同步到项目B中,由于存在区别所以还不能完全copy

需求分析


  • 公用代码迁移出去独立的 git 仓库,供其他项目共享代码
  • 公用代码原本是什么样,抽取后也是什么样,不像pod会对公用代码进行动态库或静态库的包装
  • 公用代码库是可以在不同项目间双向同步的而不是单向同步
  • 保留公用代码库的历史提交记录与双向同步记录

双向同步的栗子:A项目中依赖了子项目B,最方便的方式自然是直接在A项目里改B子项目对应的目录里的代码,然后测试通过后,直接提交代码,这个更改也提交到B子项目的 Git仓库里。同时子项目B也可以单独提交到 Git 仓库,再在A项目里把子项目B的代码update。

现有方案


  • Git Submodule:这是Git官方以前的推荐方案
  • Git Subtree:从 Git 1.5.2 开始,Git 新增并推荐使用这个功能来管理子项目
  • npm:node package manager,实际上不仅仅是 node 的包管理工具
  • composer:暂且认为他是php版npm

虽然 npm,composer,maven 等更侧重于包的依赖管理,以上几个方案都是能够做到在不同项目中同步同一块代码的,但没法双向同步,更适用于子项目代码比较稳定的情形。Git Submodule 和 Git Subtree 都是官方支持的功能,不具有依赖管理的功能,但能满足我们的要求。Git Subtree相对来说会更好一些 。

submodule 与 subtree对比

  • git submodule
    • 允许其他的仓库指定以一个commit嵌入仓库的子目录
    • 仓库 clone下来需要 initupdate
    • 会产 .gitmodule 文件记录 submodule 版本信息
    • git submodule 删除起来比较费劲
  • git subtree
    • 避免以上问题
    • 管理和更新流程比较方便
    • git subtree合并子仓库到项目中的子目录。不用像submodule那样每次子项目修改了后要initupdate 。万一哪次没update就直接add ..gitmodulecommit上去就悲剧了
    • git v1.5.2以后建议使用git subtree

实施步骤


假设P1项目、P2项目共用S项目
1. 关联Subtree
'' cd P1项目的路径
'' git subtree add --prefix=<S项目的相对路径> <S项目git地址> <分支> --squash

解释:--squash意思是把subtree的改动合并成一次commit,这样就不用拉取子项目完整的历史记录。--prefix之后的=等号也可以用空格。

2. 更新代码
P1、P2项目里各种提交commit,其中有些commit会涉及到S目录的更改,但是没关系

3. 提交更改到子项目
'' cd P1项目的路径
'' git subtree push --prefix=<S项目的相对路径> <S项目git地址> <分支>
Git 会遍历步骤2中所有的commit,从中找出针对S目录的更改,然后把这些更改记录提交到S项目的Git服务器上,并保留步骤2中的相关S的提交记录到S仓库中

4. 更新子目录
''cd P2项目的路径
''git subtree pull --prefix=<S项目的相对路径> <S项目git地址> <分支> --squash

拆分已有项目


需要从现有项目中抽取公共模块单独进行git管理
假设已有项目P抽取项目S
1. 提交日志分离
''cd P项目的路径
''git subtree split -P <S项目的相对路径> -b <临时branch>
Git 会遍历所有的commit,分离出与S项目的相对路径相关的commit,并存入临时branch中

2. 创建子repo
''mkdir <S项目新路径>
''cd S项目新路径
''git init
''git pull <P项目的路径> <临时branch>
''git remote add origin <S项目的git仓库>
''git push origin -u master

3. 清理数据
''cd P项目的路径
''git rm -rf <S项目的相对路径>
''git commit -m '移除相应模块' # 提交删除申请
''git branch -D <临时branch> # 删除临时分支

4. 添加subtree
''git subtree add --prefix=<S项目的相对路径> <S项目git地址> <分支> --squash
''git push origin master
执行完第2步时,对应的目录已经剥离出来形成独立的项目了。第3,4步主要是把当前项目的对应的文件给删除,重新在P项目建立Subtree

Tips

  • 相对路径区别大小写

参考

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

推荐阅读更多精彩内容