git submodule详解

创建子项目

git submodule add https://gitee.com/yourName/yourProject

自定义名称

git submodule add https://gitee.com/yourName/yourProject customName

子模块拉取

对于主项目使用普通的 clone 操作并不会拉取到子模块中的实际代码。
如果希望子模块代码也获取到，一种方式是在克隆主项目的时候带上参数 --recurse-submodules，这样会递归地将项目中所有子模块的代码拉取。

git clone https://github.com/username/project-main.git --recurse-submodules

另一种方式：它会根据主项目的配置信息，拉取更新子模块中的代码。

git submodule init
git submodule update

子模块代码有更新

方式一：进入到子模块目录执行拉取操作

git pull origin master

当主项目的子项目特别多时，可能会不太方便，此时可以使用 git submodule 的一个命令 foreach 执行

git submodule foreach 'git pull origin master'

如何移除 submodule 子项目

假设子项目的路径在 apps/apps-template

• 第一步

git submodule deinit apps/apps-template

执行后会删除 .git/config 中记录的 submodule 信息

• 第二步

git rm apps/apps-template

执行后移除了 apps/apps-template 文件夹，并自动在 .gitmodules 中删除了配置信息

• 第三步

rm -rf .git/modules/apps/apps-template

执行后移除了 git modules 对应的子模块信息

本地子模块有修改，强制删除，这个命令如果添加上参数 --force（-f），则子模块工作区内即使有本地的修改，也会被移除。

git submodule deinit -f apps/apps-template
git rm apps/apps-template -f