GitHub仓库导入Gitee后同步更新的方案思考

背景:

故事的起因是 保利威多场景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 master

3、推送本地最新代码到 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 ingit branch -r | grep -v -- '->'; do git branch --track ${b##origin/} $b; done

3、查看所有分支(包括本地和远程仓库分支)

git branch --all

4、推送本地仓库到 Gitee 上

这种方案更适合自动化脚本的使用,拉取所有分支再推送上去。

3、对于分支较多的仓库-主页点击

直接在仓库主页点击同步

gitee示例

在这个同步功能也可以勾选同步wiki进行覆盖


gitee示例

二、我们的选择

在背景中提到,在将仓库迁移到Gitee后,对项目ReadMe、Wiki文档中一些超链接做了调整。这种差异导致我们在三种方法中不得不放弃了最简单直接的方法三——仓库主页同步按钮直接覆盖。

在方案一、方案二的抉择中,我们也是选择了方案一。主要原因是:

  1. DEMO项目面向客户提供,分支较少,且主要使用的是master分支
  2. 因为文档超链接的差异,不得不合并两边的代码以避免冲突。

每当多场景Demo项目完成一次发版更新,就要有负责维护Gitee的同学做一次分支合并的操作,虽然耗时不多,但也在降低发版的效率。

为了使用方案三,我们决定将引起差异的外部链接,都迁移到自家的帮助中心,比如版本的发布记录、项目的集成文档。这样Github仓库和Gitee仓库只作为了代码仓库,即使出现需要超链接的部分,也只会指向同一个域名,不会出现代码上的差异。

建议

不论后面是否有迁移仓库的需求,我们也是建议在开发过程中将代码仓库中涉及的超链接可以使用绝对地址。

对于需要使用Wiki,有条件的能将Wiki放在自家域名下管理。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容