背景:
故事的起因是 保利威多场景SDK为方便客户下载demo项目代码仓库以及使用集成文档,将项目仓库以及集成文档都放在Github中。客户在使用查阅时会出现从保利威帮助中心跳转到github这一不方便的操作,更甚者会受到墙的原因而访问不稳定,无法获取到demo或者通过集成文档解决问题,这也无形中增大了售前售后对接的压力,因此21年底,保利威也在Gitee中将Github仓库做了迁移。
在将Github仓库的内容迁移到Gitee中,因为使用了相对地址,导致迁移后gitee一些链接跳转错误,或者又跳转到github中去。为了不产生链接跳转的问题,也对Gitee仓库中项目以及Wiki中涉及的超链接链地址做了改造。我们将一些文档中指向github的超链接变为了Gitee,可以将链接跳转控制在Gitee内。
那么问题来了,如何做到同步更新呢?
一、三种同步更新的方法
在Gitee帮助中心中提供了三种同步更新的方案,原文点击此处跳转:https://gitee.com/help/articles/4284#article-header1
1、对于分支较少的仓库
1、首先通过 git remote -v 查看您要同步的仓库的远程库列表,如果在列表中没有您 Gitee 的远程库地址,您需要新增一个地址
git remote add 远程库名 远程库地址
eg: git remote add gitee git@github.com:xxx/xxx.git如果在 add 的时候出现error: Could not remove config section 'remote.xxx'.一类的错误,通过把仓库下.git/config 文件里面的 [remote "xxx"] 删掉或者是用别的远程库名即可。
2、从 GitHub 上拉取最新代码到本地
git pull 远程库名 分支名
eg:git pull origin master3、推送本地最新代码到 Gitee 上
git push 远程库名 分支名
eg:git push gitee master如果出现有差异的话需要自己手动解决差异
简单来说,就是通过添加不同名称标识的远程库,拉取github分支到本地,如下图在sourcetree中所示 origin为gitee远程库、github为github远程库。
再合并到gitee本地分支,解决冲突后推送到gitee。
2、对于分支较多的仓库-脚本方法
1、克隆 GitHub 仓库到本地,命令如下
$ git clone git@github.com:xxx/xxx.git
进入仓库目录
$ cd xxx
2、一次性拉取该仓库的所有分支,命令如下:
$ for b in
git branch -r | grep -v -- '->'; do git branch --track ${b##origin/} $b; done
3、查看所有分支(包括本地和远程仓库分支)
git branch --all
4、推送本地仓库到 Gitee 上
这种方案更适合自动化脚本的使用,拉取所有分支再推送上去。
3、对于分支较多的仓库-主页点击
直接在仓库主页点击同步
在这个同步功能也可以勾选同步wiki进行覆盖
二、我们的选择
在背景中提到,在将仓库迁移到Gitee后,对项目ReadMe、Wiki文档中一些超链接做了调整。这种差异导致我们在三种方法中不得不放弃了最简单直接的方法三——仓库主页同步按钮直接覆盖。
在方案一、方案二的抉择中,我们也是选择了方案一。主要原因是:
- DEMO项目面向客户提供,分支较少,且主要使用的是master分支
- 因为文档超链接的差异,不得不合并两边的代码以避免冲突。
每当多场景Demo项目完成一次发版更新,就要有负责维护Gitee的同学做一次分支合并的操作,虽然耗时不多,但也在降低发版的效率。
为了使用方案三,我们决定将引起差异的外部链接,都迁移到自家的帮助中心,比如版本的发布记录、项目的集成文档。这样Github仓库和Gitee仓库只作为了代码仓库,即使出现需要超链接的部分,也只会指向同一个域名,不会出现代码上的差异。
建议
不论后面是否有迁移仓库的需求,我们也是建议在开发过程中将代码仓库中涉及的超链接可以使用绝对地址。
对于需要使用Wiki,有条件的能将Wiki放在自家域名下管理。