当我们要把另一个仓库的代码作为子目录放到当前仓库时,为了防止代码冗余,我们应该使用 git 的子模块 submodule 功能。
引入
把 https://github.com/my/repo.git
引入当前项目,创建一个folder
文件夹来存放代码。
git submodule add https://github.com/my/repo.git folder
此时仓库里会有个 .gitmodules
文件,记录了子仓库信息。我们可以添加多个子仓库。
提交
对主仓库、子仓库都更新代码后,我们提交时,需要依次对两个仓库的 repo 进行提交。在主仓库里进行 git diff 会看到
--- a/folder
+++ b/folder
-Subproject commit 8ffcce923b69d314938ce5485f2ac022986aebcb
+Subproject commit 8ffcce923b69d314938ce5485f2ac022986aebcb-dirty
也就是说主仓库会记录当前该文件夹所用的子项目的 commit 号,所以应该先提交子仓库,再提交主仓库。
拉取
加上--recurse-submodules
参数可以在克隆时初始化并更新子模块。
git clone xx.git --recurse-submodules
-
如果用的是 zsh,自带的 alias gcl='git clone --recurse-submodules',也就是用
gcl xx.git
就可以了。 -
一些文章提到的
--recursive
参数也是一样的作用。
初始化和更新
如果项目拉取时没有加上上面参数,那么需要手动初始化和更新。
初始化并递归更新所有子模块:
git submodule update --init --recursive
也可以分开操作,初始化只需要执行一次:
git submodule init
每次需要更新子仓库时,运行:
git submodule update
删除
还没提交 git 记录的话,把下载的文件夹和 .gitmodules 中相关内容删除即可。否则:
-
git rm --cached folder
删除目录 -
.gitmodules
删除相关内容 -
.git/config
删除.git 中相关内容 -
rm -rf .git/modules/folder
删除相关内容