git submodule 用法

​

基础用法

​

1. 正确添加子模块

git submodule add <项目B仓库URL> <子模块路径>
git commit -m "Add project B as a submodule"

​

2. 设置子模块的更新策略

[submodule "projectB"]
    path = path/to/projectB
    url = <项目B仓库URL>

​

3. 递归克隆子模块

git clone --recurse-submodules <主项目A仓库URL>

注意： 如果用户忘记加 --recurse-submodules 参数，可以手动更新子模块：

git submodule update --init --recursive

​

4. 让子模块保持与远程同步

1. 更新到远程最新提交： 使用以下命令手动同步子模块到最新的远程分支：
   git submodule update --remote --recursive
   
2. 将子模块锁定到最新的远程提交： 如果希望主项目记录最新的子模块提交，执行以下步骤：
   • 进入子模块目录：
     cd path/to/projectB
     git pull origin <branch>  # 拉取最新的远程分支
     
   • 返回主项目，提交更新的子模块引用：
     cd -
     git add path/to/projectB
     git commit -m "Update submodule to latest commit"
     

​

5. 配置自动同步子模块

git config --global submodule.recurse true

​

推荐的工作流

1. 主项目维护者在子模块有更新时，进入子模块目录拉取更新，并将最新的子模块提交记录到主项目。
2. 其他开发者在克隆主项目时，执行以下命令确保子模块同步更新：
   git clone --recurse-submodules <主项目A仓库URL>
   
   或手动初始化：
   git submodule update --init --remote --recursive
   

​

修改.gitmodules配置

​

1. 修改 .gitmodules

[submodule "module-name"]
    path = new-path
    url = new-url

​

2. 运行 git submodule sync

git submodule sync

• 如果有多个子模块，git submodule sync 会同步所有子模块。
• 如果只想同步特定子模块，可以指定路径：
  git submodule sync path/to/submodule
  

​

3. 更新子模块 URL 或内容

1. 更新 URL（如果更改了子模块的 url）：
   git submodule update --init --recursive
   
2. 如果您修改了子模块的路径，需要先移动文件夹：
   mv old-path new-path
   
3. 然后更新子模块路径并初始化：
   git submodule update --init
   

​

4. 检查同步状态

git config --file .gitmodules --list
git config --file .git/config --list

​

5. 提交更新

git add .gitmodules
git add path/to/submodule
git commit -m "Updated submodule configuration"

​

完整命令流程

# 1. 修改 .gitmodules 文件
# 2. 同步配置
git submodule sync

# 3. 如果路径变更，移动子模块目录
mv old-path new-path

# 4. 初始化或更新子模块
git submodule update --init --recursive

# 5. 提交更改
git add .gitmodules
git add new-path
git commit -m "Updated submodule configuration"