Git学习笔记(三) git submodule

简介: Git学习笔记(三) git submodule

正文


1、使用场景


有的时候,我们或许需要在一个项目中包含和使用另外的项目,同时又希望它们能够保持独立的开发

这时,git submodule 就可以很方便地帮我们处理这种情况

它能够将一个仓库作为另外一个仓库的子模块管理,同时保持他们都是独立的提交


2、基本用法


以下是基于父项目的维度管理子模块,在子模块的维度来看,它就和普通的仓库一样


  • 添加子模块:git submodule add
> # 添加子模块到父项目的根目录
> git submodule add <子模块的地址>
> # 添加子模块到父项目指定路径
> git submodule add <子模块的地址> <本地路径>


这时我们能看到,在父项目的根目录下多了一个 .gitmodules 文件,并在指定路径中多了一个子模块目录

.gitmodules  文件记录着子模块仓库与其在父项目中路径的映射关系,它要和子模块一起纳入父项目管理


  • 查看子模块:git status && git submodule status
> # 查看状态
> git status
# 第 1 种情况:子模块中有未追踪的内容,此时父项目不能将其放入暂存区
# Changes not staged for commit:
# modified:   submodule (untracked content)
# 
# 第 2 种情况:子模块中有修改过的内容,此时父项目不能将其放入暂存区
# Changes not staged for commit:
# modified:   submodule (modified content)
# 
# 第 3 种情况:子模块中有新的提交,此时父项目可以将其放入暂存区
# Changes not staged for commit:
# modified:   submodule-children (new commits)
#
# 第 4 种情况:父项目已经将子模块中新的提交放入暂存区
# Changes to be committed:
# modified:   submodule-children


> # 查看子模块提交的状态
> git submodule status


  • 修改子模块

从子模块的维度来看,其实它就是一个普通的仓库,所有可以应用于普通仓库的操作都可以应用在子模块上

从父项目的维度来看,父项目不会追踪子模块的具体内容,它只会追踪子模块的提交记录


所以,如果子模块的提交记录发生变化,父项目就可以通过 git add 以及 git commit 将其纳入管理


  • 更新子模块:git submodule update
> # 将所有子模块更新为 本地父项目中的子模块仓库最新的版本
> git submodule update
> # 将指定子模块更新为 本地父项目中的子模块仓库最新的版本
> git submodule update <submodule path>
> # 将指定子模块更新为 远程子模块仓库特定分支中最新的版本
> git submodule update --remote


这里需要注意,当执行完 git submodule update 之后,子模块的 HEAD 会处于一个游离的状态

我们需要手动将 update 的内容合并到合适的分支,或者使用 --merge 参数自动合并到当前分支

> git submodule update --merge


  • 克隆带有子模块的项目
> # 方法一:递归克隆
> git clone <父项目的地址> --recursive
> # 方法二:先克隆父项目(此时子模块目录为空),然后初始化并更新子模块
> git clone <父项目的地址> && cd <本地仓库>
> git submodule update --init --recursive

注意:

  • 在父项目切换分支时,子模块是不会自动切换的,所以我们必须手动将子模块更新 git submodule update
目录
相关文章
|
开发工具 git
Git添加子模块(submodule)
Git添加子模块(submodule)
634 0
|
29天前
|
Linux 网络安全 开发工具
Git学习笔记(一):基础与应用
本文档详细介绍了如何将本地项目关联到Gitee上的空仓库并上传代码,以及如何验证本机与Git服务器的SSH连接。同时,还概述了Git的基本概念、安装步骤、初始配置、常见命令及如何配置多个SSH-Key,适用于初学者快速上手Git操作。
104 51
Git学习笔记(一):基础与应用
|
4月前
|
安全 Linux 开发工具
Git学习笔记
这篇文章是一份Git学习笔记,涵盖了Git的基本命令、工作流程、项目搭建、文件状态管理,以及如何使用码云和IDEA进行版本控制操作。
Git学习笔记
|
7月前
|
Shell 网络安全 开发工具
Git学习笔记
Git学习笔记
138 1
Git学习笔记
|
5月前
|
存储 安全 开发工具
Git学习笔记 三个区域、文件状态、分支、常用命令
理解并掌握这些概念和命令,对于有效地使用Git来管理项目源代码是至关重要的。Git的强大功能支持了复杂的开发工作流程,而良好的Git实践能够极大地提高团队的协作效率。随着实践的增多,对于Git更深层次的功能和最佳实践的理解也会随之增长,进一步加强你作为一个软件开发者的能力。
75 0
|
7月前
|
Linux 开发工具 git
还不会 Git 子模块操作?一文教你学会 git submodule 的增、删、改、查!
还不会 Git 子模块操作?一文教你学会 git submodule 的增、删、改、查!
192 0
|
7月前
|
项目管理 开发工具 git
「译文」Git subtree: Git submodule 的替代品
「译文」Git subtree: Git submodule 的替代品
「译文」Git subtree: Git submodule 的替代品
|
7月前
|
存储 Linux 开发工具
「译文」使用 submodule 和 subtree 管理 Git 项目
「译文」使用 submodule 和 subtree 管理 Git 项目
|
7月前
|
存储 开发工具 git
将 git 仓库从 submodule 转换为 subtree
将 git 仓库从 submodule 转换为 subtree
|
Linux 网络安全 开发工具
Git学习笔记
Git学习笔记
81 0