技术博文 · 2021-06-03 0

git中submodule子模块的添加、使用和删除

添加Git子模块时如何指定分支/标记?

首先说一下submodule是做什么的。

git submodule是git的一个功能,可以将其他的github子模块工程加入到自己的项目里。在git中使用子模块的功能能够大大提高开发效率。使用子模块后,不必负责子模块的维护,只需要在必要的时候同步更新子模块即可。

一、问题背景:

今天在利用jenkins做项目构建的时候因为工程里面用到了另外一个工程(子模块工程),但是发现利用jenkins的advanced sub-modules behaviours功能拉取下来的代码并是不自己想要的分支代码。导致构建总是失败。

二、解决过程:

找到JOB所在服务器的$WORKSPACE目录,进行git status。git branch -vv等git的一些辅助命令进行查看。同时对比主工程里面的sub-module指定的子模块工程的commit版本号。

以及和子工程自身的分支的版本号进行对比发现实际上面时有偏差的,不能拉取道最新的提交的commit,于是从主工程的submodule信息配置着手进行排查。

三、解决方法:

查看主工程的.gitmodules内容发现只是指定了submodules的path和url,并没有对分支做强制要求。这就导致每次拉取的时候拉到的是主工程这边修改和提交的版本,并没有拉到子工程对应负责的同学提交的代码。所以一直构建不成功。解决方案为:在.gitmodules中添加branch 指定submodules拉取的子工程的分支版本即可。

四、再来说说submodule的一些其他使用方式

1、git将submodule有关的信息在哪?

git将submodule有关的信息保存在两个地方:

.gitmodules在仓库中,有版本控制,修改之后会同步到其他仓库,使用submodule相关命令的时候会自动更新 .git/config在本地,需要手动更新,或者执行git submodule sync将新的配置从.gitmodules拷贝到.git/config git submodule sync会将submodule远程的 url 配置设置到.gitmodules,并且只会影响.git/config已经有 url 的条目,指定–recursive,将会递归更新注册的submodule

查看submodule

[root@192 cloudm-console-mvntar]#git submodule
+aa8f66218b83404685e9e7b232cf44f7420905c4 clouddm-js (remotes/origin/feat/may)

2、子模块的添加

添加子模块非常简单,命令如下:

git submodule add <url> <path>

其中,url为子模块的路径,path为该子模块存储的目录路径。

执行成功后,git status会看到项目中修改了.gitmodules,并增加了一个新文件(为刚刚添加的路径)

git diff --cached      查看修改内容可以看到增加了子模块,并且新文件下为子模块的提交hash摘要

git commit       提交即完成子模块的添加

3、子模块仓库更新

github 子模块多仓库代码更新。

git submodule sync
git submodule update --init

当使用git clone下来的工程中带有submodule时,初始的时候,submodule的内容并不会自动下载下来的,此时,只需执行如下命令:

git submodule init
git submodule update
或:
git submodule update --init --recursive

执行后,子模块目录下就有了源码,再执行相应的makefile即可。

子模块的更新 子模块的维护者提交了更新后,使用子模块的项目必须手动更新才能包含最新的提交。

在项目中,进入到子模块目录下,执行 git pull更新,查看git log查看相应提交。

完成后返回到项目目录,可以看到子模块有待提交的更新,使用git add,提交即可。

4、删除子模块

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

删除子模块较复杂,步骤如下:

rm -rf 子模块目录 删除子模块目录及源码
vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
vi .git/config 删除配置项中子模块相关条目
rm .git/module/* 删除模块下的子模块目录,每个子模块对应一个目录,注意只删除对应的子模块目录即可
执行:git submodule status
linux下执行:
git ls-files --stage | grep 160000 
windows下执行:
git ls-files --stage | findstr 160000

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

git rm --cached 子模块名称

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

5、切换子模块分支

基础概念: git添加一个submodule,只需要添加该module的github源码地址,不需要设置tag。但是submodule下载下来的源码其实是有tag,而且是稳定不会改变的tag。

如何修改:进入到submodule对应的文件夹地址,

git checkout <tagname>   切换到你想要的tag 
git add dirname
git commit
git push

总的说就是 git submodule 指定第三方库的源地址和下载到那个目录,这个目标目录保存了github信息就是git tag。两者结合实现了submodule 下载第三方库源码并切换到指定分支。

所以想换submodule的分支或tag,只需要修改文件夹就可以(git checkout ..)注意:Git版本需要≥ 1.8.2,该版本增加了跟踪分支的可能性

cd submodule_directory
git checkout v1.0
cd ..
git add submodule_directory
git commit -m "moved submodule to v1.0"
git push

参考:添加git子模块时如何指定分支/标记?

git submodule在jenkins上使用的坑

git-github 子模块仓库更新(git submodule)/git中submodule子模块的添加、使用和删除

将Git子模块更新为最新