git中submodule的用法解析

简介

为了方便项目的统一管理,paas平台采用的是pnpm的多包管理机制,目录结构如下client编辑器的sdk、demo编辑器的功能展示、servernest中间层。采用这种方式就会存在代码回滚和commit紊乱的痛点。

packages下的项目没有单独的进行commit的管理,导致我只想回滚client时会把demoserver的编写的代码也进行回滚。为了解决此问题引入了git submodule子模块的概念,来分别管理clientdemoserver的commit记录,他们也依旧保留在主项目里,代码结构不变。 接下来就来讲解一下submodule的使用

用法

创建

首先我们现在git创建子项目git-submodule-1, 然后采用git submodule add git子仓库在主项目git-submodule引入这个子项目。同时会生成.gitmoudles文件记录子模块之间的映射

ts 复制代码
git submodule add https://github.com/AKclown/git-submodule-1.git

紧接着我们将主代码仓库push到远程仓库里

子模块的初始化

在上面我们通过git submodule add ~会同时把~仓库的代码clone下来,但是当其他用户在本地直接git clone 主仓库时是不会同步clone子仓库的代码的。 我在别的目录clone主仓库代码,可以看到子仓库的README.md并没有clone下来,如下两种方式来clone子仓库代码

方式一

csharp 复制代码
git submodule init  
git submodule update

通过如上两个命令就可以将子仓库的代码clone下来了。那么接下来就来分析一下上面两条命令的含义

  1. git submodule init是将.gitmodules的映射复制到./.git/config文件里 git submodule init ~ 还可以指定特定子模块,而不是全部
  2. git submodule update更新子模块代码到本地。git submodule update ~也可以指定对应的那个子模块

方式二

在克隆主仓库时,追加--recurse-submodules参数会把子仓库的代码一同clone下来

ts 复制代码
git clone git@github.com:AKclown/git-submodule.git --recurse-submodules

工作流

跟我们日常的git操作一样

在子仓库中

  1. 执行git pull origin main拉取代码
  2. git checkout -b ~创建功能分支
  3. git add/commit/push 提交代码 更新子模块1readme文件,可以并且进行push可以看到在主仓库会生成两个文件git-submodule-1git-submodule-2.这两个文件记录当前子仓库的最新commitId如下图所示 git-submodule-2更新了readme但还未提交,他的commitId会标记为dirty草稿的意思 Tips: 有了这两个文件辅助,我们在进行代码发布版本时,推送一次主仓库是不是就知道了此次version子仓库最新提交commitID

拉取子模块远程更新

  1. 拉取git-submodule-1仓库更新
bash 复制代码
cd git-submodule-1
git pull origin main
  1. 拉取所有子模块更新. foreach => 遍历
csharp 复制代码
> git submodule foreach 'git pull origin main'

删除子模块

有时候我们想要卸载子模块,可以通过如何命令git submodule deinit ~

ts 复制代码
git submodule deinit git-submodule-1

可以看出.gitmodules文件还存在子模块映射,以及packages目录下也还存在git-submodule-1代码文件。执行如下代码,即可清除它们

ts 复制代码
git rm git-submodule-1

当我们子模块代码有更新还未提交时,如果我们想强制删除子模块,只需要添加--force参数即可

ts 复制代码
git submodule deinit -f git-submodule-2

总结

通过上面的代码,我们学会了submodule的基础用法。在有使用到多包的场景也许能够更好的管理每个仓库的commit信息。最终仓库代码,子模块在主仓库以链接的形式展现

相关推荐
Tab609几秒前
接入谷歌home/assistant/智能音箱
服务器·前端·智能音箱
小高0077 分钟前
2026 年,只会写 div 和 css 的前端将彻底失业
前端·javascript·vue.js
Anita_Sun7 分钟前
Lodash 源码解读与原理分析 - Lodash 原型链的完整结构
前端
梁森的掘金7 分钟前
Frida Hook 流程
前端
www_stdio9 分钟前
Git 提交AI神器:用大模型帮你写出规范的 Commit Message
前端·javascript·react.js
陈随易9 分钟前
Bun v1.3.6发布,内置tar解压缩,各方面提速又提速
前端·后端
双向3310 分钟前
【AIGC爆款内容生成全攻略:如何用AI颠覆内容创作效率?】
前端
陈_杨17 分钟前
前端成功转鸿蒙开发者真实案例,教大家如何开发鸿蒙APP-- 卡片编辑功能
前端·harmonyos
Swift社区22 分钟前
Flutter 的异步问题,为什么和前端 Promise 问题高度相似?
前端·flutter
程序员Agions23 分钟前
AI 编程的"效率幻觉":为什么用了 Cursor 之后,你反而更累了?
前端·ai编程