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

参考资料

相关推荐
不老刘14 小时前
Antigravity 的 New Worktree 模式:给 AI 代理一个安全的“平行工位”
人工智能·git·ai编程·antigravity
光谱SpectrAI14 小时前
Windows 也中招:Git Bash 和 Node 仍信任泄露的 eMudhra 证书
git
YIN_尹15 小时前
【git原理与使用】git初识与安装
大数据·git·elasticsearch
Leo_Mr19 小时前
Vue3 项目配置 Git 提交规范(企业通用方案:husky + commitlint + cz-git + lint-staged)
git
jyOverQ20 小时前
Git rebase 和 merge 有什么区别?什么时候该用哪个?
git
晗夜未央20 小时前
跨仓库 Skill 换台电脑就失效?用 Git remote 校验项目
人工智能·git·python
Lsetea20 小时前
Git访问HTTPS证书不受信任:用URL级sslCAInfo限定私有CA范围
git·https·开发工具·ssl证书·ca证书
এ慕ོ冬℘゜1 天前
Git 基础入门|和 SVN 对比 + 四大区域 + 常用命令详解
git·svn
DevLoom_2 天前
macOS 命令行 curl/git 报 SSL 证书错误?eMudhra 事件完整修复指南
git·macos·ssl
keyipatience2 天前
Git学习(4)Git分布式优势与实战配置全解析
git·学习