git 之 submodule

r囧r小猫 2022-11-15 05:56 388阅读 0赞

文章目录

  • 0x00 使用说明
  • 0x01 添加子模块
      1. 创建子模块
      1. 查看子模块
      1. 主项目克隆到本地
  • 0x02 更新子模块
      1. 子模块有改动，未提交
      1. 子模块远程有更新
      1. 子模块 url 有了自己的想法
      1. 有趣的 foreach
  • 0x03 删除子模块
      1. 方式一：自动删除(建议)
      1. 方式二：手动删除
  • 0x04 参考资料

0x00 使用说明

git 子模块的一些快速上手技巧

0x01 添加子模块

  • 本地项目：project-main

    https://github.com/xxx/project-main.git （仓库地址不可用）

  • 子项目：project-sub

    https://github.com/xxx/project-sub.git （仓库地址不可用）

1. 创建子模块

前提：本地已经有一个主项目，但是没有子模块。

命令：git submodule add <submodule_url>

注意请用 https 开头的连接，而不是 git 开头的

  1. $ git submodule add https://github.com/xxx/project-sub.git project-sub

添加子模块，然后运行git status,

可以看到目录有增加2个文件

  • .gitmodules，这个文件用来保存子模块的信息。

  • project-sub，这个就是你所创建的子模块的文件夹

    $ git status
    On branch master

    Initial commit

    Changes to be committed:
    (use “git rm —cached …” to unstage)

    1. new file:   .gitmodules
    2. new file:   project-sub

    根目录下的文件：.gitmodules

    [submodule “project-sub”]

    1. path = project-sub
    2. url = https://github.com/xxx/project-sub.git

如果此前项目中已经存在 .gitmodules 文件，则会在文件内容中多出上述三行记录。

这时候，建议先提交一次 commit

2. 查看子模块

  1. $ git submodule
  2.  e33f854d3f51f5ebd771a68da05ad0371a3c0570 project-sub (heads/master)

3. 主项目克隆到本地

还有一种情况是，带有子模块的主项目需要从仓库中拉取

  1. $ git clone https://github.com/xxx/project-main.git

在主项目文件夹中，有 project-sub 该文件夹

但是里面是空的

  1. # 子模块前面有一个`-`，说明子模块文件还未检入（空文件夹）。
  2. $ git submodule
  3.  -e33f854d3f51f5ebd771a68da05ad0371a3c0570 assets
  5. $ ls project-sub
  6. $

这个时候，需要执行两个：init + update

  1. # 进入到 project-sub 同级目录
  2. $ git submodule init
  3. $ git submodule update

另外一种不用手动更新子模块的方式（不适合分支子模块）

  1. $ git clone https://github.com/xxx/project-main.git --recurse-submodules

0x02 更新子模块

使用查看命令来观察项目变动是一个好习惯

  1. $ git status
  3. # 查看版本异同
  4. $ git diff
  5. $ git diff --submodule

1. 子模块有改动，未提交

开发环境居多，直接在项目中更改代码，但是没有递交到远程仓库

  1. 进入子文件夹，提交更新
  2. 到项目中，提交子仓库更新

有一种情况，你忘了子模块推送，直接把主项目推送了，造成了版本紊乱，悔之晚矣。这时候需要 git 来校验我们是否将子模块推送了

  1. $ git push --recurse-submodules=check

2. 子模块远程有更新

负责子模块开发的人做了一些版本升级工作

  • 方式一：进入到子文件夹，同步远程仓库

    1. # 进入到子文件夹，像同步远程仓库一样操作
    2. $ cd project-sub
    4. # 拉取仓库方式1
    5. $ git fetch
    6. $ git merge origin/master
    8. # 拉取仓库方式2 （建议）
    9. $ git pull --rebase

  • 方式二：在主项目中进行更新，默认是 master 分支，更改分支改动在 .gitmodules 或者 .git/config 文件中

    1. $ git submodule update --remote
    3. # 更改分支
    4. $ git config -f .gitmodules submodule.project-sub.branch <branch_name>

在这个时候呢，还有一种情况，远程仓库有了版本升级，要同步远程仓库

  1. # 在主项目中执行拉取操作，不会同步更新子模块
  2. $ git pull
  4. # 同步远程主项目和子模块
  5. $ git pull --recurse-submodules

3. 子模块 url 有了自己的想法

有一种情况，子模块变更了托管的平台。此时，若父级项目引用的子模块提交不在仓库中本地配置的子模块远端上，那么执行 git pull --recurse-submodules 或 git submodule update 就会失败。

在你写 ci 的时候，需要极其注意这个东西。因为好的 ci，只需要写一遍就够了。

  1. # 将新的 URL 复制到本地配置中
  2. $ git submodule sync --recursive
  3. # 从新 URL 更新子模块
  4. $ git submodule update --init --recursive

4. 有趣的 foreach

当你有多个子模块的时候，想要对所有子模块执行相同的操作，比如更新子模块远程仓库，需要一个一个修改过去特别麻瓜。

这个时候就需要使用下面这个命令

  1. git submodule foreach 'git pull origin master'

0x03 删除子模块

1. 方式一：自动删除(建议)

  1. # 在子模块同级目录下面
  2. $ git submodule deinit project-sub
  4. # 连同子模块工作区的工作一块删除
  5. $ git submodule deinit project-sub --force

上面的命令执行的工作流程等同于下面方式二

2. 方式二：手动删除

  1. 删除子模块文件夹

    1. $ git rm --cached project-sub
    2. $ rm -rf project-sub

  2. 删除 .gitmodules 文件中相关子模块信息

    1. [submodule "project-sub"]
    2.   path = assets
    3.   url = https://github.com/xxx/project-sub.git

  3. 删除 .git/config 中的相关子模块信息

    1. [submodule "project-sub"]
    2.   url = https://github.com/xxx/project-sub.git

  4. 删除 .git 文件夹中的相关子模块文件

    1. $ rm -rf .git/modules/project-sub

0x04 参考资料

  • 7.11 Git 工具 - 子模块
  • Git中submodule的使用
  • Git submodule 子模块的管理和使用
  • Git 官方文档

发表评论

表情：
评论列表 （有 0 条评论，388人围观）

还没有评论，来说两句吧...

相关阅读

    相关 Git之submodule初识

    一 概述 今天突然碰到一个从没碰到过的Git问题，就是将一个Git仓库放在其他的Git仓库中，然后执行\[git add .\]命令的时候出现了提示信息： ![wate

    小灰灰小灰灰/ 0 赞/ 259 阅读

    相关 Git Submodule 使用简介

    D瓜哥从去年开始，将所有的笔记都整合到了自建的 Wiki 中。整理分析，确实方便很多。 最近有两个部分，比较独立，自成系统。其中，有一个模块还考虑和其他小伙伴合作来搞。所以，

    落日映苍穹つ落日映苍穹つ/ 0 赞/ 300 阅读

    相关 git submodule的使用

    开发过程中，经常会有一些通用的部分希望抽取出来做成一个公共库来提供给别的工程来使用，而公共代码库的版本管理是个麻烦的事情。今天无意中发现了git的git submodule命令

    谁践踏了优雅谁践踏了优雅/ 0 赞/ 301 阅读

    相关 git Submodule的使用

    当一个项目需要包含其他支持项目源码时使用的功能，作用是两个项目是独立的，且主项目可以使用另一个支持项目。 git submodule add <submodule_u

    短命女短命女/ 0 赞/ 311 阅读

    相关 Git Submodule 使用技巧

    有的时候我们会遇到仓库嵌套的问题，即一个 Git 仓库内部还有一个 Git 仓库，这里我们可以使用 Git 的模块化。 现在我拥有一个 git 项目 `blog`，它的内部有

    旧城等待，旧城等待，/ 0 赞/ 406 阅读