git submodule

git submodule 的作用是将一个 git 仓库，最为另一个 git 仓库的子模块

比如
A 仓库地址：git@github.com:xxxxxxx/A.git
B 仓库地址：git@github.com:xxxxxxx/B.git

一、克隆 A 仓库

打开拉取的 A 项目根目录
在 A 项目中添加 B 项目的 git 仓库，作为子模块，设置 B 项目在 A 项目中的路径是 A/client/Assets/B
打开命令行，执行命令

git submodule add git@github.com:xxxxxx/B.git client/Assets/B

A 项目目录下出现两个文件

.gitmobule
client/Assets/B

打开 .gitmodule 显示 三行信息

[submodule "client/Assets/B"]path = client/Assets/Burl = git@github.com:XXXXXX/B.git

这里一般默认使用 submodule 仓库 (B)的 master 或者 main 分支
如果想使用哪一个分支，添加 branch，修改如下

[submodule "client/Assets/B"]path = client/Assets/Burl = git@github.com:LIQIANGEASTSUN/B.gitbranch = master_sdk # 确保这里是 master_sdk 分支

在可视化 git 工具，如：SourceTree 上选择 client/Assets/B 可以看到 里边是一条指向 B 项目某一次提交的 commit
B 仓库作为 A 仓库的 submodule，此时 B 仓库并不是在哪个分支上，而是在 B 仓库的某一条提交
A 仓库只是在使用 B 仓库某一次提交的状态，具体细节可以自行查资料

二、初始化子模块，执行命令

git submodule init

三、更新 submodule，执行命令

git submodule update

git submodule update 命令会将子模块检出到父仓库中记录的提交
只有在明确地更新并提交了子模块的状态后，父仓库才会知道子模块现在指向的是最新的提交

要确保当前使用的 submodule 是最新的提交，递归的将所有子模块更新到远程仓库的最新提交
执行命令：

git submodule update --remote --recursive

如果只是想更新具体的 submodule 如 client/Assets/B，将 --recursive 替换为具体的 submodule 名
执行命令

git submodule update --remote client/Assets/B

四、提交子模块的更新

更新子模块后，需要将子模块的状态提交到父仓库，执行以下命令：

git add client/Assets/B
git commit -m "Update submodule to latest commit"
git push

五、查看 submodule 状态

git submodule status
输出：daddf8e4fe8b122128c63d69fd73fd031269285a client/Assets/B(heads/master_sdk)

六、已经克隆的项目更新 submodule

一个项目已经克隆到本地了，别人添加了一个 submodule 并提交，我们本地仓库需要更新，执行命令：

# 初始化和更新所有子模块
git submodule update --init --recursive

然后执行 三、四

七、克隆一个添加了 submodule 的仓库

执行命令

git clone --recurse-submodules git@github.com:XXXXX/A.git
git submodule update --init --recursive

执行 三 、四
如果克隆时没有添加 --recurse-submodules 克隆完成后，执行 二、三 、六、七

八、删除子模块

1. 删除子模块的条目
   首先，从 .gitmodules 文件中删除子模块的相关配置
   打开 .gitmodules 文件，找到并删除与要移除的子模块相关的条目，如下

[submodule "client/Assets/B"]path = client/Assets/Burl = git@github.com:xxxxxx/B.gitbranch = master_sdk # 确保这里是 master_sdk 分支

2. 删除子模块的配置
   接下来，从 Git 配置中删除子模块的条目。您可以使用以下命令：

git config --remove-section submodule.client/Assets/B

也可以打开 .git/config 文件手动删除，如下

[submodule "client/Assets/B"]active = trueurl = git@github.com:LIQIANGEASTSUN/B.git

3. 删除子模块的目录 .git\modules\client\Assets\B 目录

rm -rf client/Assets/B

4. 将这些更改提交到父仓库

git add .gitmodules
git commit -m "Remove submodule client/Assets/B"
git push

5. 清理 Git 缓存（可选）
   如果希望完全清理 Git 的缓存，可以运行以下命令：

git rm --cached client/Assets/B

6. 移除子模块
   首先，使用以下命令移除子模块：
   取消子模块的初始化
   git submodule deinit -f client/Assets/B

从工作目录和索引中移除子模块

git rm -f client/Assets/B