git submodule 了解下

使用git submodule进行项目管理

历史背景

  新进公司小萌新发现公司的各模块拆出来单独做了服务,但是有个问题就是各服务共同依赖一个node服务做转发,日常开发的小项目的时候需要开启node服务再开启小项目做调试。这里就有两个东西让人很不爽

  • 一个小项目就是一个node_modules,这个包数量简直让人裂开
  • 调试项目的时候,即使只是调试页面,也必须先开启node服务,再启动小项目,咱想一个命令行打开两个服务。

  咱谏言可以用lerna统一管理各项目,多项目依赖共同管理,再用concurrently,就可以一键开服务。
  那问题是,现在各项目都放在各自的git仓库做管理,如果所有项目统一移动到某个大项目,可能会涉及到CI脚本之类的修改,这尼玛工作量可大了。有木有办法不动原本的git仓库呢,俺寻思,git 貌似有submodule的功能是不是可以用呢,这里就来了解下git submodule

搭建包含submodule的仓库

  首先我们先建立几个子项目扔github上面。我这里的Test作为主仓库,其他的作为子模块。


09R{`H5J3VO1%4QAX0FRYPE.png

  本地建立一个空的git仓库(咱先加上.gitignore)


empty

  接下来添加我们所需要的子模块打开terminal输入 git submodule add <git仓库url路径>。现在咱的本地git 以及github的git就长这样。
remote
local

  其中.gitmodules是用于记录该项目的子模块信息,GitHub上面文件夹也直接指向了相关模块的url。
  首先在根目录,yarn init -y,yarn add lerna ,然后需要修改package.json,添加 "private":true,(只有private的项目才能使用workspace)以及workspace,最后yarn install如下图所示


package.json

使用子模块工作

  现在我们用子模块工作,首先从最简单的场景开始,我们不在主项目修改子模块的代码,主项目只是单纯的做一个集成项目,并且我们默认主项目与子模块都在一个分支上开发。这个时候我们的子模块做了修改并推送到remote,我们主项目要获取子模块的代码时只需要执行git submodule update --remote。这个命令可以看作在所有子模块下执行一次git pull。当子模块更新的时候,主项目所记录的子模块的git head也会随着更新具体如下所示。

head change

  需要注意的是git submodule update --remote默认是拉取remote的master branch。
  具体表现为,当你的某个子项目的dev branch更新后,在marin project执行git submodule update --remote,然后去子项目手动checkou dev branch。此时子模块处于dev branch代码更改是正常的,但是当你在main project再次git submodule update --remote时,会发现子项目还是回到了master分支。
  这个时候需要指定相关git submodule所追溯的branch。命令行如下git config -f .gitmodules submodule.<submodule name>.branch <target branch>,注意这里的-f .gitmodules命令如果不设定的话,更改的就只有本地仓库的branch指向,其他人那里是不会同步branch指向的。

  再来看看另外的情景。在主项目上面修改了主项目同时修改了子项目。然后我在主项目push,子项目push
  这里需要注意的是,当你的子项目以及主项目都有更改的时候,你的主项目push并不会将子项目的内容同样的push到remote,所以主项目push之后再次执行git submodule update --remote 后会发现自己的更改并没有生效,并且自己的提交记录也无法在branch里面找到。因为上面这个指令将会强制将remote的子模块内容覆盖本地,所以之前提交的那个记录head会作为一个detached head,即不被分支追踪的记录head
  为了避免以上场景出现,我们可以使用git push --recurse-submodules=on-demand,这个命令在push main project之前会先去submodule 执行一次push
  另一种场景就是主项目修改了子项目的内容,同时子项目也有修改,需要使用git submodule update --remote --merge这样就能全量的去fetch & merge子项目。

  这里还有个比较实用的submodule 指令,foreach可以执行所有子项目的命令(因为update只支持merge rebase之类的基本命令),比如git submodule foreach 'git stash'之类的。

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

推荐阅读更多精彩内容