BlueRose
文章90
标签22
分类7
使用Git SubModule来管理开源插件

使用Git SubModule来管理开源插件

前言

之前有考虑过将项目中自己的移植版AdvancedLocomotionSystem v4换成社区维护版本ALS-Community。众所周知,如果主仓库下存在子.git文件夹,那子.git文件夹中的改动主仓库是无法检测到的,除非把子.git删除。但我既想在主项目中使用git来管理版本又想在插件中保留git信息以方便从github中获取最新的改动。查了一番资料,最后发现git已经给出了解决方案:Git SubModule。

用法

submodule add

第一步添加submodule,命令为:

git submodule add url path

例如:

git submodule add https://github.com/dyanikoglu/ALS-Community.git Plugins/ALS-Community

执行完之后就会出现.gitmodules文件,里面主要是git submodule相关信息。

同时还会有一个与子模块同名的文件出现,它记录Commit的hash值,如果子模块的Commit发生变动,主仓库的这个文件都会出现改动。

在上传github之后,点击这个文件就会自动跳转到之前定义的仓库url。

Clone

默认的clone可能会出现submodule为空的情况。这是需要在Clone后面加上--recurse-submodules选项。例如:

git clone —recurse-submodules https://github.com/XXXX/XXXX

个人建议

因为考虑到后续可能会修改插件,所以还是建议先fork一下目标仓库,之后git submodule add这个仓库。这样依然可以通过添加原仓库Remote的方式来更新代码。

最近本人开始使用Obsidian笔记,把Github图床仓库作为子模块下载到Asset目录下,或许也是个不错的选择。

Git-Fork

这里我推荐git-fork这个软件,免费小巧又好用。特别是打开源码仓库的时候,速度比SourceTree快多了。默认情况下已经可以自动下载submodule。
另外说一点,点击标签页右边的+,除了会显示之前打开过的仓库之外,还会显示这些仓库目录下的子仓库,可以说是相当方便了。