美文网首页
GIT版本中引入“公共”库的解决方案——submodule

GIT版本中引入“公共”库的解决方案——submodule

作者: PHP的点滴 | 来源:发表于2020-12-03 14:48 被阅读0次

背景介绍

在不同的项目,经常会使用到一些通用 工具、代码;
比如 常见的 StrHelper.php,DataHelper.php
如果一个方法到处复制粘贴,虽然可行,但是如果这个工具方法有改动的话,则相当的麻烦!

解决方案 - submodule

借助 git submodule 则可以轻松管理这个问题,只需要下面几步:

1.子模块的添加

添加子模块非常简单,命令如下:
git submodule add <url> <path>

git submodule add https://github.com/jasonyqwang/Utils.git vendor/utils

其中,url为子模块的路径,path为该子模块存储的目录路径。
执行成功后,git status会看到项目中修改了.gitmodules,并增加了一个新文件(为刚刚添加的路径)
git diff --cached查看修改内容可以看到增加了子模块,并且新文件下为子模块的提交hash摘要
git commit提交即完成子模块的添加
其中 .gitmodules 内容如下

[submodule "vendor/utils"]
    path = vendor/utils
    url = https://github.com/jasonyqwang/Utils.git

2.子模块的使用

克隆项目后,默认子模块目录下无任何内容。需要在项目根目录执行如下命令完成子模块的下载:

git submodule init
git submodule update
或者
git submodule update --init --recursive

执行后,子模块目录下就有了源码!!!

3.删除子模块

有时子模块的项目维护地址发生了变化,或者需要替换子模块,就需要删除原有的子模块。

删除子模块,步骤如下:

rm -rf 子模块目录 删除子模块目录及源码
vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
vi .git/config 删除配置项中子模块相关条目
rm .git/module/* 删除模块下的子模块目录,每个子模块对应一个目录,注意只删除对应的子模块目录即可

执行完成后,再执行添加子模块命令即可,如果仍然报错,执行如下:

git rm --cached 子模块名称

完成删除后,提交到仓库即可。

相关文章

网友评论

      本文标题:GIT版本中引入“公共”库的解决方案——submodule

      本文链接:https://www.haomeiwen.com/subject/eiemwktx.html