架构优化——submodule转为subtree

背景

submodule过多，目前20个submodule需要切出20个分支，查看提交记录、切分支等使用起来麻烦。

团队深受困扰！

subtree优势

1. 继承submodule的优点，基础功能仓库，可被其他多个仓库同时使用
2. 开发时，不需要再切n个分支，也不需要提到不同仓库，只需要往主仓库推送即可，一个仓库一个分支，搞定日常开发，让开发工作更愉快
3. 代码合并时，不需要再合那么多子仓库

submodule切换到subtree脚本

可以一键切换，但是要注意m_branch的更改，更改为子模块你想追踪的分支名

#!/bin/bash
# set -e
m_branch="release/3_5_6_2"
cat .gitmodules | while read i; do
  if [[ $i == \[submodule* ]]; then
    echo converting $i
    read i
    mpath=$(echo $i | grep -E "(\S+)$" -o)
    echo path: $mpath
    read i
    murl=$(echo $i | cut -d= -f2 | xargs)
    echo url: $murl
    mname=$(basename $mpath)
    echo name: $mname

    # 先获取 commit，必须在 git rm 之前
    mcommit=$(git ls-tree HEAD "$mpath" | awk '{print $3}')
    echo commit: $mcommit

    git submodule deinit -f "$mpath"
    echo "11"
    git add .
    git commit -m "#40664 Stage .gitmodules changes before removing submodule"
    git rm -r --cached "$mpath"

    echo "22"
    rm -rf "$mpath"
    echo "33"
    git config -f .gitmodules --remove-section "submodule.$mpath" || true
    echo "44"
    git config --remove-section "submodule.$mpath" || true
    echo "55"
    git commit -m "#40664 Removed $mpath submodule at commit $mcommit"
    echo "66"
    if ! git remote get-url "$mname" &>/dev/null; then
      git remote add "$mname" "$murl"
    fi
    echo "77"

    # git fetch "$mname"

    # 用 commit 创建临时分支并用它 add subtree
    # git branch -f "_$mname" "$mcommit"
    echo "88"
    git add .
    git commit -m "#40664 Save changes before subtree add"
    echo "mpath:$mpath murl:$murl  m_branch:${m_branch} "
    git subtree add --prefix="$mpath" "$murl" "${m_branch}"
    echo "99"
    # git branch -D "_$mname"
    echo "10"

    git commit -m "#40664 Converted $mpath submodule to subtree"
    echo "11"
    git push origin "${m_branch}"

    echo
  fi
done

git rm -f .gitmodules
git commit -m "#40664 Removed .gitmodules after converting submodules"

subtree使用

接入subtree后，日常开发提交代码，切分支等，都只对主仓库进行操作，日常使用起来，就只是主仓库。

更新的内容也只在主仓库生效（默认子仓库不会同步更新）

如需单独更新子模块仓库，需要用特殊的命令

切开发分支

git checkout -b  feature/3553_xzx_subtree
git push origin  feature/3553_xzx_subtree
# 以上即可开始开发

推送代码

git add 修改文件
git commit -m "修改内容"
git push origin  feature/3553_xzx_subtree
# 以上即可推送修改到云端（只会更新quicktron仓库），然后直接打包即可，会把提交的修改带上

如果需要单独推送子模块仓库（只开发quicktron，是不需要做这一步的）

例如params_api未来可能被quicktron以及算法那边的仓库共同使用，我们在params_api修复了bug，则需要推送到子模块仓库中去，让算法那边也可同步到我们的修改，则使用以下命令：

git subtree push --prefix=src/nav_process ssh://git@gitlab.flashhold.com:10022/hardware/upper_computer/basic/nav_process.git feature/3553_xzx_subtree

同步代码

git pull origin release/3_5_5_3
git push origin  feature/3553_xzx_subtree
# 以上即可同步最新修改到本地，并且推送到quicktron仓库

如果需要单独更新某个子模块（只开发quicktron，是不需要做这一步的）

例如params_api被算法那边修复了bug，并且已经推送到对应子仓库了，那我们需要同步最新修改到qucktron

则使用以下命令：

git subtree pull --prefix=src/params_api ssh://git@gitlab.flashhold.com:10022/hardware/upper_computer/basic/nav_process.git release/3_5_5_3
git push origin  feature/3553_xzx_subtree

在submodule初步切为subtree这段时间，可能有原先是submodule形式的提交，在nav_process子仓库上的修改，需要同步到subtree形式的主线上，则也是使用以上指令。