Git Submodule 使用

Posted 2023-04-18

参考技术A git 的 submodule 作为一个独立的 repo , 其拥有普通 repo 全部的功能, 我们可以完全按照普通的 repo 管理命令来进入 submodule 中进行手动管理. 不过如果存在多个 submodule 位于同一 superproject 下时, 掌握一些 git submodule ... 命令就变得尤为重要了.

本文列出了常用的一些 git submodule 管理命令, 并举出实际应用中遇到的问题及解决方案.

在 git 仓库 superproject 的目录中使用 git submodule add https://github/HanleyLee/C 即可将 https://github/HanleyLee/C 作为一个 submodule 被 superproject 依赖与管理.

当 submodule 被修改时我们可以在 superproject 中得到通知:

在 repo Test 作为 submodule 被 superproject 管理后:

添加 git submodule 的方法很简单, 使用 git submodule add <repo url> 即可. 添加完之后, 在 superproject 的目录下会产生一个 .gitmodule 文件, 文件的结构如下:

可以看到, .gitmodule 文件中标记了每一个 submodule 的 path 与 url .

然后我们进入 ./C :

我们发现 ./C/.git 竟然是一个文件 (常规 git 目录中的 .git 是文件夹), 然后其内容指向了另一个文件夹 (类似于指针), 我们再去到那个文件夹:

我们发现这个文件夹才是 submodule 的真实 .git 文件夹, 我们对于 submodule 的所做的 commit 信息也都保存在这里.

默认情况下, git pull 命令会递归地抓取子模块的更改 (fetch), 然而, 它不会将 submodule merge 到所跟踪的分支上. 因此我们还需要执行 git submodule update .

如果我们想一句话解决, 那么可以使用 git pull --recurse-submodule , 这个可以在拉取完 submodule 后再将其 merge 到所跟踪的分支上.

如果我们想让 Git 总是以 --recurse-submodules 拉取, 可以将配置选项 submodule.recurse 设置为 true . 具体命令为 git config --global submodule.recurse true . 此选项会让 Git 为所有支持 --recurse-submodules 的命令使用该选项 (除 clone 以外).

如果我们在主项目中提交并推送但并不推送子模块上的改动, 其他尝试检出我们修改的人会遇到麻烦, 因为他们无法得到依赖的子模块改动. 那些改动只存在于我们本地的拷贝中.

为了确保这不会发生, 我们可以让 Git 在推送到主项目前检查所有 submodule 是否已推送. git push 命令接受可以设置为 check 或 on-demand 的 --recurse-submodules 参数. 如果任何提交的 submodule 改动没有推送那么 check 选项会直接使 push 操作失败.(此外还有 demand , while , no 选项, 参考前节命令列表进行理解)

为了以后方便, 我们可以设置默认检查 git config --global push.recurseSubmodules check

很多人用了 git submodule 后, 都发现每次 update 之后, submodule 中的 HEAD 都是 detached 状态的, 即使本次 git checkout master 后, 下次更新仍然恢复原样, 难道就没有办法使其固定在某个 branch 上吗? 经过研究, 参考 stackoverflow 的答案, 我发现是可以解决的.

问题的关键在于 .gitmodule 的配置:

我们需要添加 update = rebase 这行, 根据 git official 的说明

submodule 的 update 有多种选择, 默认情况下是 checkout , 其会根据 superproject 所记录的 submodule 的 commit 进行 checkout. 类似于 git checkout 4eda5fgrd , 这必然导致 submodule 的 HEAD 处于 detached 状态. 解决办法就是使用 rebase ( merge 也可以), 这样当我们对 submodule 设置了一个初始的 branch 后, 其以后都只会在这个 branch 上对远程的最新 commit 进行 rebase , 不会导致 detached 状态的产生.

以 submodule 的目录为 ./C/ 为例. 具体的解决步骤如下:

此时, 以后再使用 git submodule update 就不会有 detached 状态的产生了

git submodule

使用这个的前提：

1.project依赖不太大，比較简单，5个以内吧（比較大了还是用android 的 repo吧）

2.注意submodule的提交须要在它的文件夹下运行

3.注意 git submodule update

4.循环运行能够使用git submodule foreach git submodule update

主要应用与 使用了别人的库，不须要自己维护

总之就是简单。可是不可过度依赖，依赖各种子模块用repo吧，安卓上那么多project依旧执行完美

開始

建立

git submodule add helloworld.git

git commit -m "Add submodules helloworld.git"

其它人协同

git clone /path/to/repos/helloworld_parent.git

git submodule init

git submodule update

或者

git clone --recursive /path/to/repos/foo.git

移除

1.删除git cache和物理目录

2.删除.gitmodules的内容（或者整个文件） 由于本例仅仅有两个子模块，直接删除文件

3.删除.git/config的submodule配置 源文件

4.提交更改

git user‘s manual for submodule