巧用git submodule子模块,轻松维护大项目
项目中如果经常需要使用一些子模块,子模块可以单独独立成为一个仓库,由专人维护。使用子模块后,不必负责子模块的维护,只需要在必要的时候同步更新子模块即可。这就需要使用Git的submodule功能。
公司一些大项目,依赖很多其他的子项目。而且这些子项目,被用在多个大项目中,就中情况,就需要使用了git submodule子项目功能。判断项目是否使用了该功能,可以查看项目根目录,是否存在了一个.gitmodule
文件。
官方介绍https://git-scm.com/docs/git-submodule
使用
子模块的添加
添加子模块非常简单,命令如下:
1 | git submodule add <url> <path> |
其中,url为子模块的路径,path为该子模块存储的目录路径。
执行成功后,git status会看到项目中修改了.gitmodules,并增加了一个新文件(为刚刚添加的路径)
子模块的使用
克隆项目后,默认子模块目录下无任何内容。需要在项目根目录执行如下命令完成子模块的下载:
1 | git submodule init |
或:
1 | git submodule update --init --recursive |
执行后,子模块目录下就有了源码,再执行相应的makefile即可。
子模块的更新
子模块的维护者提交了更新后,使用子模块的项目必须手动更新才能包含最新的提交。
在项目中,进入到子模块目录下,执行 git pull
更新,查看git log
查看相应提交。
注意子模块目录中的branch和子模块的实际仓库的branch可能不一致,有时候需要切换到相应的目录,再执行git pull
完成后返回到项目目录,可以看到子模块.gitmodules
有修改,有待提交的更新,使用git add
,提交即可。
删除子模块
有时子模块的项目维护地址发生了变化,或者需要替换子模块,就需要删除原有的子模块。
删除子模块较复杂,步骤如下:
rm -rf 子模块目录
删除子模块目录及源码vi .gitmodules
删除项目目录下.gitmodules文件中子模块相关条目vi .git/config
删除配置项中子模块相关条目rm .git/module/*
删除模块下的子模块目录,每个子模块对应一个目录,注意只删除对应的子模块目录即可
执行完成后,再执行添加子模块命令即可,如果仍然报错,执行如下:
1 | git rm --cached 子模块名称 |
完成删除后,提交到仓库即可。
参考文章
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 螃蟹壳!