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

参考资料

相关推荐
小此方2 小时前
「插曲:Git」企业规范篇:DevOps开发模型、Git Flow五类分支设计与测试/预发布/生产环境Bug修复及Hotfix紧急发布流程
git·bug·devops
溪语流沙2 小时前
【Web全栈进阶】JWT无状态认证:签发、校验、刷新
前端·git·python·github
OsDepK3 小时前
osgit纯图形化git版本管理工具,多人开发团队协作工具,支持Mac与Windows
git
Madison-No79 小时前
Git版本控制工具(一)
git
小小小米粒18 小时前
重置本地git
大数据·git·elasticsearch
鶴哥只手遮天1 天前
第 8 章 工作区与检出:unpack-trees 与并行 checkout
git
xing-xing1 天前
git 相关命令总结
git
A-刘晨阳1 天前
GitLab + ArgoCD 实现 Kubernetes GitOps 自动化部署
运维·人工智能·git·kubernetes·自动化·云计算·argocd
ControlRookie2 天前
SyncBridge:一个 CODESYS 工程与 AI 之间工程师级的同步工具
git·ai编程·codesys·工业软件·controlrookie
鬼手点金2 天前
opencode-性能优化建议
java·人工智能·git·自动化·nanogpt