在Git中添加子模块(submodule)的详细步骤

 更新时间:2026年01月09日 09:36:13   作者:Tipriest_  
Git子模块(submodule)允许在一个项目中包含另一个独立的git仓库,使用时需注意,子模块提交push后,主模块需同步更新其记录的子模块hash值,否则可能导致冲突,本文详细介绍了如何添加子模块,需要的朋友可以参考下

在 Git 中添加子模块(submodule)的详细步骤如下:

1. 添加子模块

命令格式

git submodule add <仓库URL> [目标路径]
  • 仓库URL:子模块的 Git 仓库地址(HTTP/SSH 均可)。
  • 目标路径(可选):子模块在主仓库中的存放路径。若省略,默认使用仓库名称作为路径。

示例

git submodule add https://github.com/example/thirdparty.git libs/thirdparty
  • thirdparty 仓库添加到主仓库的 libs/thirdparty 目录下。

执行后效果

  1. 克隆子模块仓库到指定路径。
  2. 在主仓库根目录生成 .gitmodules 文件,记录子模块信息(URL 和路径)。
  3. .git/modules/ 目录下保存子模块的 Git 元数据。

2. 提交主仓库的变更

子模块添加后,主仓库会生成两个变更:

  • .gitmodules 文件(新增)。
  • 子模块路径对应的提交 ID(类似 160000 模式的文件)。

提交命令

git commit -m "添加子模块: thirdparty"

3. 克隆含子模块的主仓库

其他协作者克隆主仓库后,需初始化子模块:

方式一:递归克隆(推荐)

git clone --recurse-submodules <主仓库URL>
  • 一次性克隆主仓库并初始化所有子模块。

方式二:分步初始化

克隆主仓库:

git clone <主仓库URL>

初始化子模块:

git submodule init

拉取子模块代码:

git submodule update

4. 更新子模块

拉取子模块的最新代码

进入子模块目录:

cd libs/thirdparty

拉取更新并切换至最新提交:

git checkout main  # 切换到目标分支
git pull

返回主仓库目录,提交子模块的变更:

cd ../..
git add libs/thirdparty
git commit -m "更新子模块 thirdparty 到最新版本"

批量更新所有子模块

git submodule foreach git pull

5. 删除子模块

删除子模块条目:

git rm -f libs/thirdpackage

删除 .git/modules/thirdparty 目录(手动操作):

rm -rf .git/modules/libs/thirdpackage

提交变更:

git commit -m "移除子模块 thirdpackage"

注意事项

  1. 路径冲突:确保目标路径为空,否则会报错 '<路径>' already exists
  2. 子模块独立性:子模块的修改需在子模块目录内单独提交,主仓库仅记录其提交 ID。
  3. 分支跟踪:默认子模块处于“游离 HEAD”状态,如需跟踪分支,需手动切换:
cd libs/thirdparty
git checkout main

通过以上步骤,你可以将外部仓库作为子模块嵌入主项目,并管理其版本和更新。

到此这篇关于在Git中添加子模块(submodule)的详细步骤的文章就介绍到这了,更多相关Git添加子模块submodule内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Scratch3.0 页面初始化同时加载sb3文件的操作代码

    Scratch3.0 页面初始化同时加载sb3文件的操作代码

    今天通过本文给大家分享Scratch3.0 页面初始化同时加载sb3文件的操作代码,感兴趣的朋友一起看看吧
    2021-08-08
  • 使用Git上传本地仓库到github仓库的实现

    使用Git上传本地仓库到github仓库的实现

    这篇文章主要介绍了使用Git上传本地仓库到github仓库的实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-06-06
  • 音视频基本概念和FFmpeg的简单入门教程详解

    音视频基本概念和FFmpeg的简单入门教程详解

    FFmpeg是一套可以用来记录、转换数字音频、视频,并能将其转化为流的开源计算机程序。可以轻易地实现多种视频格式之间的相互转换,这篇文章主要介绍了音视频基本概念和FFmpeg的简单入门,需要的朋友可以参考下
    2022-04-04
  • 几款开源的中文分词系统

    几款开源的中文分词系统

    中文分词是做好中文内容检索、文本分析的基础,主要应用于搜索引擎与数据挖掘领域。中文是以词为基本语素单位,而词与词之间并不像英语一样有空格来分隔,因而中文分词的难点在于如何准确而又快速地进行分词
    2012-11-11
  • Git代码冲突问题分析及解决方案

    Git代码冲突问题分析及解决方案

    本文介绍了解决Git代码冲突的两种方法:使用IntelliJ IDEA工具和Git命令行,通过对比不同分支的代码差异,选择有效代码进行合并,在IntelliJ IDEA中,可以通过Merge功能解决冲突;在Git命令行中,需要手动编辑冲突文件并提交修改
    2025-11-11
  • git如何使用Sourcetree合并多次本地提交记录

    git如何使用Sourcetree合并多次本地提交记录

    这篇文章主要介绍了git如何使用Sourcetree合并多次本地提交记录,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • Node后端Express框架安装及应用

    Node后端Express框架安装及应用

    Express 是一个简洁而灵活的 node.js Web应用框架, 提供了一系列强大特性帮助你创建各种 Web 应用和丰富的 HTTP 工具,如果你不会jJava or Python等后端,使用 Express可以帮助我们快速地搭建一个完整功能的网站
    2021-08-08
  • Jenkins 脚本命令行应用小结

    Jenkins 脚本命令行应用小结

    这篇文章主要介绍了Jenkins 脚本命令行应用总结,包括批量删除Jenkins 项目构建记录,非多分支项目及分支项目,文章结合示例代码给大家介绍的非常详细,需要的朋友可以参考下
    2022-04-04
  • 使用.gitignore文件简化Git仓库管理

    使用.gitignore文件简化Git仓库管理

    .gitignore文件用于指定在git中应该被忽略的文件或目录,前端的node_modules目录包含大量文件,如果将其添加到版本管理系统中,会使仓库变得庞大,不利于仓库的管理,本文介绍了使用.gitignore文件来简化你的Git仓库管理
    2023-10-10
  • UTF-8 编码中BOM的检测与删除

    UTF-8 编码中BOM的检测与删除

    所谓BOM,全称是Byte Order Mark,它是一个Unicode字符,通常出现在文本的开头,用来标识字节序(Big/Little Endian),除此以外还可以标识编码(UTF-8/16/32),如果出现在文本中间,则解释为zero width no-break space。
    2011-09-09

最新评论