Git添加子模块

有种情况我们经常会遇到：某个工作中的项目需要包含并使用另一个项目。 也许是第三方库，或者你独立开发的，用于多个父项目的库。 现在问题来了：你想要把它们当做两个独立的项目，同时又想在一个项目中使用另一个。这种情况就可以使用Git子模块。

1. 创建父仓库

clone地址: https://github.com/xxx/parent.git

2. 创建子仓库

clone地址: https://github.com/xxx/child.git

注: 创建仓库的时候勾选README.md,保证不是空仓库

3. 在父仓库下添加子仓库依赖

在父目录下，执行git submodule add https://github.com/xxx/child.git
这时运行 git status
会出现

Your branch is up-to-date with 'origin/master'.

Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    new file:   .gitmodules
    new file:   DbConnector

此时执行

git add.
git commit -m "add submodule"
git push

4. 克隆一个含有子模块的项目

如果单纯的使用git clone命令，当你在克隆这样的项目时，默认会包含该子模块目录，但其中还没有任何文件。解决办法：

• 方式一：运行两个命令：git submodule init 用来初始化本地配置文件，而 git submodule update 则从该项目中抓取所有数据并检出父项目中列出的合适的提交。也可以合成一步，使用git submodule update --init，如果还要初始化、抓取并检出任何嵌套的子模块， 请使用简明的 git submodule update --init --recursive
• 方式二： 使用git clone --recurse-submodules https://github.com/xxx/parent.git命令进行克隆，就会自动初始化并更新仓库中的每一个子模块， 包括可能存在的嵌套子模块。

5. 更新子模块代码

git submodule update --remoteGit 默认会尝试更新 所有 子模块， 所以如果有很多子模块的话，你可以传递想要更新的子模块的名字。例: git submodule update --remote submoduleName
此命令默认会假定你想要更新并检出子模块仓库的 master 分支，不过你也可以设置为想要的其他分支，那么既可以在 .gitmodules 文件中设置 （这样其他人也可以跟踪它），也可以只在本地的 .git/config 文件中设置。
git config -f .gitmodules submodule.submoduleName.branch develop

6. git pull 父项目，如何保证子模块也拉到了最新

如果你想自动化此过程，那么可以为 git pull 命令添加 --recurse-submodules 选项（从 Git 2.14 开始）。
你想让 Git 总是以 --recurse-submodules 拉取，可以将配置选项 submodule.recurse 设置为 true （从 Git 2.15 开始可用于 git pull）。此选项会让 Git 为所有支持 --recurse-submodules 的命令使用该选项（除 clone 以外）。

7. 更改子模块代码并提交

• 首先，进入每个子模块并检出其相应的工作分支。 接着，若你做了更改就需要告诉 Git 它该做什么，然后运行 git submodule update --remote 来从上游拉取新工作。 你可以选择将它们合并到你的本地工作中git submodule update --remote --merge，也可以尝试将你的工作变基到新的更改上git submodule update --remote --rebase。
• 发布子模块改动：
  你可以让 Git 在推送到主项目前检查所有子模块是否已推送。 git push 命令接受可以设置为 “check” 或 “on-demand” 的 --recurse-submodules 参数。 如果任何提交的子模块改动没有推送那么 “check” 选项会直接使 push 操作失败。git push --recurse-submodules=check
  进入每一个子模块中然后手动推送到远程仓库，确保它们能被外部访问到，之后再次尝试这次推送。

删除子模块

步骤如下：
rm -rf 子模块目录 删除子模块目录及源码
vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
vi .git/config 删除配置项中子模块相关条目
rm .git/module/* 删除模块下的子模块目录，每个子模块对应一个目录，注意只删除对应的子模块目录即可
执行完成后，再执行添加子模块命令即可，如果仍然报错，执行如下：

git rm -f --cached 子模块名称

完成删除后，提交到仓库即可。