【Git系列】git submodule-单项目多仓库管理方案

1、基本介绍:

  • 当项目比较大的时候便于复用,或者多个项目共用module。这个时候需要抽取项目公共模块,而且现在基本是使用git作为版本控制工具,这样就变成App Project 有多个module,每个module都是一个独立的git repository。而且我们希望单个的module都可以独立维护,可以更方便查看和随时随地同步更新。
  • 为了达成这样的目的我们可以使用git-submodulegit-repogitslavegit-subtree
  • git-repo更适合管理比较大、module比较多、module会经常变更的项目,Android源码就是采用这种方式管理。如果module比较少的情况,使用git-submodule完全够用。

2、使用步骤:

  1. 进入到主项目根目录中输入命令
    • git submodule add <子module的git地址> : 从远程仓库将子module导入到该项目中,这时候会自动生成.gitmodules文件
    • git submodule add <子module的git地址> <主项目内的文件夹>: 从远程仓库将子module导入到该项目中的特定文件夹中。
    • git submodule init:初始化本地.gitmodules文件。
    • git submodule update:在父项目中更新子module的修改。
    • git submodule foreach git pull:拉取所有子模块。
    • git submodule foreach git submodule update:如果你的submodule又依赖了submodule,可以使用git submodule foreach命令来实现一次性全更新。
    • git clone --recurse-submodules <主项目仓库地址>:获取主项目和所有子项目源码【git pull <主项目仓库地址>的时候不会同时获取submodules的源码】。
  2. 进入到子module目录中输入命令
    • 走正常的git add、git commit、git push流程。

3、注意点:

3.1、更新 submodule 的坑:

  • 在父项目中git pull只会更新父项目中的代码,并不会更新子module项目中的代码,这时忘记了调用 git submodule update,那么git push极有可能再次把旧的 submodule 依赖信息提交上去。
  • git pull 之后,立即执行 git status, 如果发现 submodule 有修改,立即执行 git submodule update
  • 如果你的 submodule 又依赖了 submodule,那么很可能你需要在 git pullgit submodule update 之后,再分别到每个 submodule 中再执行一次 git submodule update,这里可以使用 git submodule foreach git submodule update命令来实现。

3.2、修改 submodule 的坑:

  • 默认 git submodule update 并不会将 submodule 切到任何 branch,所以,默认下 submodule 的 HEAD 是处于游离状态的 (‘detached HEAD’ state)。所以在修改前,记得一定要用 git checkout master 将当前的 submodule 分支切换到 master,然后才能做修改和提交。
  • 如果你不慎忘记切换到 master 分支,又做了提交,可以用 cherry-pick 命令挽救。具体做法如下:
  • git checkout master 将 HEAD 从游离状态切换到 master 分支 , 这时候,git 会报 Warning 说有一个提交没有在 branch 上,记住这个提交的 change-id(假如 change-id 为 aaaa)。
  • git cherry-pick aaaa 来将刚刚的提交作用在 master 分支上。
  • git push 将更新提交到远程版本库中。

3.3、删除 submodule 的坑:

  • 直接删除子模块并不能完全删除,再次添加的时候会报错'<submodule子项目名字>' already exists in the index.
  • 用以下命令可以完全删除submodule:
    git rm --cached <submodule子项目名字>
    rm -rf <submodule子项目名字>

参考:http://blog.devtang.com/2013/05/08/git-submodule-issues/

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

推荐阅读更多精彩内容