使用 Git Submodules 的 Monorepo
你将构建什么
一个主仓库,将共享库作为 submodule 包含,含初始化、更新和同步 submodule 的脚本。
学习目标
- 用 git submodule add 添加 submodule
- 用 --recursive 克隆含 submodule 的仓库
- 将 submodule 更新到较新提交
- 为团队编写工作流文档
前置要求
- 基础 Git 工作流
- 仓库托管(GitHub/GitLab)
- 项目依赖理解
步骤
- 1
设计仓库结构
规划布局:一个 shared-lib 仓库(独立),一个主应用仓库将 shared-lib 作为 submodule 包含。记录文件归属。验收:创建前结构清晰。
提示
Submodule 固定子仓库的特定提交,使主仓库始终针对已知版本构建。
- 2
创建并添加 submodule
在托管平台创建 shared-lib 仓库,然后在主仓库运行 git submodule add <url> shared-lib。提交新的 .gitmodules 文件。验收:submodule 作为子目录出现。
提示
.gitmodules 文件记录 submodule URL 和路径——提交它让队友获得引用。
- 3
带 submodule 克隆
用 git clone --recursive <url> 全新克隆主仓库。没有 --recursive,submodule 目录为空。验收:全新克隆有 submodule 内容。
提示
对已存在的克隆,运行 git submodule update --init --recursive 获取 submodule 内容。
- 4
更新 submodule
在 shared-lib 仓库(submodule 目录内)做新提交、push,然后在主仓库用 git add shared-lib 暂存 submodule 指针并提交。验收:主仓库现在固定新 submodule 提交。
提示
将 submodule 视为存储提交哈希的文件——更新它意味着改变该哈希。
- 5
编写团队工作流文档
编写 README 部分,涵盖:如何克隆(用 --recursive)、如何更新 submodule(git submodule update --remote)、常见陷阱(detached HEAD、忘记提交指针)。验收:新队友能照做。
提示
最常见陷阱是拉取新 submodule 更改后忘记提交更新的 submodule 指针。
自己动手试试
你学到了什么
你用 submodule 管理了多仓库设置——跨团队共享代码的常见模式,其取舍你现在已理解(复杂度 vs. 隔离)。
相关资源
相关课程
- 分支
Submodule 跨仓库固定特定提交。
查阅不认识的术语
新手友好的术语表用大白话解释编程术语——变量、函数、DOM、Promise 等等。
解读错误信息
用大白话解释常见错误——什么意思、为什么发生、如何修复。