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 以及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..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'之类的。