背景
最近项目由于一些特殊需要,使用了git的submodules工具来引入一个子项目到主项目中。然而考虑submodules工具在团队协作开发的过程中,容易出现子项目版本不一致的问题,于是研发了git_submodule_version_checker这款工具来解决。
1、关于git的submodules工具的介绍可以点击阅读《Git 工具 - 子模块》。
2、关于git的submodules工具的优缺点,有兴趣的请直接Google吧,目前网上已经很多资料了。总得来说,其最大的(可能也是唯一的)优点是:允许开发者将一个子项目的git仓库作为主项目git 仓库的子目录,并让子项目保持提交的独立;而其突出的缺点主要有以下几个:
主项目仓库不记录子项目仓库的文件变动,只记录子项目仓库的commitId,在这个背景下,团队协作开发过程中容易产生子项目版本不一致的问题,具体表现如下:
- 团队协作开发时,若有成员更新了子项目,但是你
git pull
后,却没有运行git submodule update --remote
更新子项目本地仓库,那么你极有可能再次把旧的子项目版本信息(子项目仓库依然指向一个旧的commitId)提交至主项目- 团队协作开发时,若你在本地改动了子项目,并在主项目中提交并推送了子项目版本信息,但却没有推送子项目仓库上的改动,这时其他成员在拉取更新后,运行
git submodule update
时,会遇到“找不到所引用的子模块提交”的错误提示
- 每次更新子项目仓库,子项目仓库都会回到游离状态,在这个背景下, 会产生的问题有:
- 若你已经切换到指定分支,在更新后,需要手动切换分支;
- 若你对子项目做了修改,但是忘记了提交,这时候执行更新,会导致修改被丢失;
子项目仓库总是需要手动更新(不过可以通过自动化工具编写帮助解决此问题)