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

参考资料

相关推荐
SStone_TJ1 小时前
【常用的git命令】
git
没有鸡汤吃不下饭2 小时前
Git将某个分支合并到开发(dev)、测试(test)后突然想撤销该分支的功能,怎么处理?
前端·git·github
康一夏2 小时前
git fatal:Server aborted the SSL handshake
git·网络协议·ssl
Vio72517 小时前
在IntelliJ IDEA中使用Git
git
Net_Walke18 小时前
git 的常用命令
git·物联网·github·iot
L X..1 天前
Git 无法访问 GitHub(Recv failure: Connection was reset)问题解决教程
git·github
建群新人小猿1 天前
客户标签自动管理:标签自动化运营,画像持久保鲜
android·java·大数据·前端·git
来一颗砂糖橘1 天前
Git 进阶指南:深入掌握 git log 查看提交历史
git·版本控制·开发技巧
六点半8882 天前
【Git】远程操作 + 给命令配置别名 + 标签管理
git
虫师c2 天前
GitOps实战:ArgoCD+Tekton打造云原生CI/CD流水线
git·ci/cd·云原生·kubernetes·argocd·tekton