Git Submodule简单使用

Git Submodule

近期用到了这个命令,主要是为了实现在一个git仓库中,引入其他git仓库,这种适用于你想在主工程中引入其他library库,主工程以submodule的形式包含子工程,子工程可以有自己的git操作,比如commit、push、rebase等。

这里笔者用一个实际的例子来介绍这个命令的使用,不知道大家有没有在原生工程嵌入React Native?熟悉React Native工程的同学会知道有个一个android工程,如下图:

android submodule

你会发现下面还会有一个iOS工程,我们客户端开发一般都会各自维护一个git仓库,为了让Android跟iOS不在同一个工程提交commit,主要是为了方便维护,所以就想着怎么在RN工程中引入Android工程和iOS工程,明白我们的需求之后,我们知道git中有submodule的操作,所以下面直接实操吧。

添加submodule工程

git submodule add http://git.code.oa.com/TCW/Crowdsource-android.git android

执行完这条命令之后,通过git status,可以看到变更信息:

On branch master
Your branch is up-to-date with 'origin/master'.
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    new file:   .gitmodules
    new file:   android

然后添加子模块:

git add .getmodules android
git commit -m "add android submodule."
git submodule init

ok,到这里你成功添加了一个submodule.

修改Submodule

进入submodule.

cd android

我这里的submodule是android.

这时我修改了android工程里面的内容,git status一下:

modify submodule

提交submodule的内容到远程:

git add .
git commit -m "嵌入React Native"
git push

提交后,看下Submodule在主工程中的变更:

cd ..
git status

如下图:

modify submodule

这时候,提交主工程的变更:

git add .
git commit -m "update android submodule"
git push

ok,这里已经成功修改了submodule.

更新Submodule

这里有个问题,你在自己机器完成了submodule的添加和修改,那其他同学想更新怎么办?

在主工程根目录运行以下命令:

git submodule foreach git pull

还需要更新下submodule:

cd android
git pull

ok,这样其他团队成员就能拉到最新的工程代码啦。

总结

关于如何在RN工程中通过submodule方式引入android工程已经大致实操了一遍,还有clone submodule和remove submodule的操作就不演示了,可以参考下面提供的链接。

更多参考

使用Git Submodule管理子模块

### Git Submodule使用方法 #### 添加子模块 通过 `git submodule add` 命令可以向主项目中添加一个子模块。该命令需要指定远程仓库地址以及目标路径。例如,如果希望将某个仓库作为子模块添加到当前项目的 `path/to/submodule` 路径下,则执行如下命令[^2]: ```bash git submodule add https://github.com/username/repo.git path/to/submodule ``` 此操作会克隆指定的远程仓库至本地目录,并将其记录为主项目中的一个子模块。 --- #### 初始化和更新子模块 当克隆包含子模块的主项目时,默认情况下不会自动下载子模块的内容。此时需运行以下两条命令完成初始化与同步工作[^3]: 1. **初始化子模块配置** ```bash git submodule init ``` 2. **获取子模块的实际数据** ```bash git submodule update ``` 这两步也可简化为一条命令实现相同效果: ```bash git submodule update --init --recursive ``` 其中参数说明如下: - `--init`: 根据 `.gitmodules` 文件定义的信息初始化所有未初始化过的子模块; - `--recursive`: 如果某些子模块本身也含有其他子模块,则递归处理这些深层嵌套关系。 --- #### 更新已有子模块版本 假如上游仓库有了新的提交而想让自己的项目跟上最新变化,可先进入对应子模块所在的工作树根部后再拉取更改或者直接在父级目录统一操作: ```bash cd path/to/submodule && git pull origin main # 或者更简便的方式是在顶级目录一次性解决多个子模组的情况: git submodule foreach 'git pull origin main' ``` 以上方式能够确保各子模块都处于最新的状态之中[^3]。 --- #### 移除不再使用的子模块 删除不必要的子模块分为几个阶段来进行清理动作, 需要注意的是每一步骤都要小心谨慎以免误删资料造成不可逆的影响. 首先编辑`.gitmodules`, 删除对应的条目;其次移除存储于`.git/config`内的关联设置项;最后物理清除磁盘上的实际档案夹并告知Git不必继续追踪该项资源即可[^3]. 具体指令序列如下所示 : ```bash # 编辑 .gitmodules 文件手动去掉相关内容或利用下面这条命令自动化部分流程 git config -f .gitmodules --remove-section submodule.<name> # 清理配置残留物 git rm --cached <path_to_submodule> rm -rf <path_to_submodule>/.git/ # 提交改动反映最终结果 git commit -m "Remove submodule <name>" ``` --- 尽管如此,在现代 Go 开发环境下,由于官方推荐采用 Modules 来管理外部包依赖关系,因此除非特殊场景需求(比如要固定特定分支标签而非单纯语义化版本号),否则一般建议优先考虑内置工具链所提供的解决方案而不是额外引入复杂度较高的Submodules架构设计思路[^1]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小巫技术博客

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值