git submodule简易指南

场景说明

  • 你想在一个主仓库中引用另一个 Git 仓库(如组件库、工具库);
  • 保持两个仓库的独立性,但又能在主项目中集成使用;
  • 子模块中的代码不会直接包含在主仓库的 Git 记录中,只记录引用的 commit。

子模块初始化

克隆项目时自动拉取子模块:

bash 复制代码
git clone --recurse-submodules <repo-url>

如果已经克隆了项目,但未拉取子模块,请执行:

css 复制代码
git submodule update --init --recursive

子模块目录结构(示例)

go 复制代码
my-project/
├── .gitmodules
├── packages/
│   └── shared-ui/         ← 子模块(实际是另一个 Git 仓库)
│       ├── components/
│       └── package.json

添加子模块

xml 复制代码
git submodule add <git-url> <target-folder>

示例:

bash 复制代码
git submodule add https://github.com/your-org/shared-ui.git packages/shared-ui

提交变更:

sql 复制代码
git commit -am "chore: add submodule shared-ui"

更新子模块

如果子模块有更新:

bash 复制代码
cd packages/shared-ui
git pull origin main

然后在主项目中提交引用的 commit 更新:

bash 复制代码
cd ../..
git add packages/shared-ui
git commit -m "chore: update shared-ui submodule"

移除子模块

  1. 删除记录:
bash 复制代码
git submodule deinit -f packages/shared-ui
git rm -f packages/shared-ui
rm -rf .git/modules/packages/shared-ui
  1. 清理 .gitmodules 中的条目:
bash 复制代码
# 编辑 .gitmodules,手动删除对应子模块条目

注意事项

注意点 描述
子模块是只读 默认你不能在主项目中直接修改子模块内容,需要切换到子模块目录进行修改。
提交更新需两次 commit 修改子模块后,需要提交子模块自身的变更,然后回到主仓库提交 commit 引用更新。
勿忘 .gitmodules 这个文件记录子模块来源及路径,需一起提交。
CI/CD 中记得拉取子模块 如:git submodule update --init --recursive

参考资料

相关推荐
程序媛Dev15 小时前
50.4k Star!我用这个神器,在五分钟内搭建了一个私有 Git 服务器!
运维·服务器·git
澈轩18 小时前
Git 用得好,下班走得早
git
人间造梦工厂19 小时前
Git Bash 别名
git
画个太阳作晴天1 天前
解决 Android Studio 中 build 目录已被 Git 跟踪后的忽略问题
git
wjs0401 天前
Git常用的命令
java·git·gitlab
原野风霜3241 天前
Git使用总结
git
青草地溪水旁1 天前
Git Bash 中 Git 命令的实用主义指南
git·bash
至善迎风1 天前
版本管理系统与平台(权威资料核对、深入解析、行业选型与国产平台补充)
git·gitee·gitlab·github·svm
上单带刀不带妹1 天前
Git rm 命令与系统 rm 命令的区别详解
git
我的收藏手册2 天前
性能监控shell脚本编写
前端·git·github