git-使用submodule的坑

一. 为什么要使用submodule?

面对比较复杂的项目,我们有可能会将代码根据功能拆解成不同的子模块。主项目对子模块有依赖关系,却又并不关心子模块的内部开发流程细节。这种情况下,可以使用git 的submodule来建立当前项目和子项目的依赖关系。

二. submodule的操作

2.1 submodule的创建

通过 git submodule add <submodule_url> 可以创建一个submodule,也可以通过其他git图形化工具便捷创建。

创建成功后,会多出一个包含了子模块的相关信息的.gitmodules 文件,同时会把子模块下载到当前目录中。

2.2 submodule的拉取

有三种方式更新项目内的submodule:

  1. 主项目的 fetchpull 操作不会更新到子模块,所以我们可以在这些操作后面加上 --recurse-submodules, 这样就可以同步到子模块。
  2. 当然最简单的还是切到子模块的目录下,通过正常的拉取操作就ok。
  3. 在主项目中直接通过 git submodule update 来更新子模块的代码。

2.3 submodule 的提交

最好直接到子模块的目录下,按照正常的git操作对子模块进行正常的提交流程。

三. 重头戏:submodule的坑

3.1 submodule游离态分支下的提交丢失

如果主工程中进行git submodule update操作 ,会把子模块的当前分支切换成游离态 "Detached Head",而非任何已有的分支!例如下图中的分支名称为游离态的的@72b2861 这种格式.

image.png

很多时候我们没有切换过分支,会在没注意的情况下把修改提交到了这个游离态分支上。然后如果切了master(或者其他已有的)分支后,这个游离态分支和本次的commit都消失不见了,特别是用的图形化git工具(如github客户端,sourcetree等),没法找到这个游离态分支了。


image.png

这个时候可能大家有点慌了,我的提交怎么被遁入虚空了?我一天的心血白费了?
但是你先别慌,要相信git的强大和可靠性。我们既然提交了那么就一定有记录,只要我们找到并且恢复就没事。

解决方案1:

当前分支如果还是游离态分支,可以查看当前提交的commit的change-id,然后到正常的分支上cherry-pick这个commit即可。具体操作如下:

  1. git checkout master 将 HEAD 从游离状态切换到 master 分支 , 这时候,git 会报 Warning 说有一个提交没有在 branch 上,记住这个提交的 change-id(假如 change-id 为 aaaa);
  2. git cherry-pick aaaa 来将刚刚的提交作用在 master 分支上;
  3. git push 将更新提交到远程版本库中;

命令行操作记录如下:

➜ ui_common git:(df697f9) git checkout master
Warning: you are leaving 1 commit behind, not connected to
any of your branches:

  df697f9 forget to check out master

If you want to keep them by creating a new branch, this may be a good time
to do so with:

 git branch new_branch_name df697f911e5a0f09d883f8f360977e470c53d81e

Switched to branch 'master'
➜ ui_common git:(master) git cherry-pick df697f9

解决方案2:

如果使用图形化git工具,有些在切换分支到其他分支时没有方案1里面提示的warning(例如github客户端),所以切到其他分支后就不知道commit的change-id。
在这种情况下,我们只需要再回到游离态分支,然后查看提交的记录就ok了。

  1. 首先通过在主工程中进行git submodule update操作,把当前分支重置到游离态分支;
  2. 使用git log 或图形化工具查看commit列表,找到丢失的commit,万事大吉
  3. 万事大吉个屁,我发现git log里面根本没有我们丢失的commit记录。我知道你很慌,但是先别慌。因为我知道git还有另外一个更详尽的git操作记录:git reflog,我们在reflog中再找找。
  4. 果然我们在git reflog中可以找到丢失的commit,在master分支中cherry-pick这个提交,万事大吉

解决方案2的手把手图形化工具教程

如果是git命令行老手,使用命令行工具可以很快处理submodule的commit丢失问题。
但是如果是不会使用git命令行的新手,可以按照下面的流程,手把手教你恢复。下面是恢复流程:

  1. 安装毫无争议的世界第一的git工具:tortoisegit(小乌龟),后面的流程是基于此工具的。安装流程略过;

  2. 在主项目目录中使用submodule update,可以再次把子模块重置回游离态。

    image.png

  3. 转到子模块的目录,打开RefLog弹窗。


    image.png
  4. 在RefLog目录应该可以看到自己提交的不见的commit了!


    image.png
  5. 到这里我们便知道了丢失的commit的change-id,最方便的还是使用git命令行直接cherry-pick丢失的commit,然后后面的流程就可以忽略了,万事大吉
    但如果不会使用git命令行,就接着往下看吧。
    因为tortoisegit工具的cherrypick功能只能从已有分支中选择,无法找到游离态的分支,所以我们可以通过创建一个分支的方法来曲线救国。

  6. 右键这个commit,从丢失的commit创建一个分支TestA;


    image.png
  7. 切换到master分支,打开Git Show Log.


    image.png
  8. 在git log界面把界面显示的分支切到TestA,然后将丢失的commit cherry-pick到master分支就可以了!


    image.png
  9. 上传前记得把临时的TestA分支删掉,万事大吉

四. 参考链接

唐巧的博客:Git submodule的坑

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容