团队代码协作规范 及 产品发布流程

团队代码协作规范 - 基于git flow工作流

git-flow

分支解释:

  • master :不允许开发者对代码进行修改和提交。该分支上的代码随时可以部署到生产环境
  • develop:是开发过程中代码中心分支。不允许开发者直接进行修改和提交(只允许MR(PR),以下MR 均指 Merge Request)
  • Release:临时分支:上线的准备工作和预演环境的bug。绝不能包含需求变更或功能变更等重大修正。这一阶段的提交数应该限制到最低
  • Hotfix:临时分支,修复紧急bug的分支;紧急bug定义:无法等到下个版本的bug
  • Feature:开发分支,已完成的feature 需要在适当时间删除;需要其他开发者对对此次MR进行code review,在通过审核后Accept Merge Request 发布到dev

优势:

  • 通过不同分支间的交互规划了一套软件开发、集成、部署的工作流
  • 基于不同分支完成不同环境的发布
  • CodeReview,开发者的代码,可以在MR 到dev branch 过程进行peer review,再MR 到release branch 时做 lead review
  • 可直接集成各种CI tools,进行持续发布;不过一般情况是,测试环境采取 auto deploy,预演和生产环境 manual deploy

实施要求:

  • 整个团队的纪律性要求很高
  • 要求团队成员熟练掌握git 指令、gitflow原理流程
  • 有git-flow 扩展指令集,推荐使用sourceTree 做为git-flow gui 工具

注意事项:

  • 两条主分支:develop & master,贯彻整个流程始终
  • feature 分支,粒度划分要细,建议不超过一周,杜绝出现long-lived-branches;多人协作时;建议每日从dev pull 一次代码;建议发起mr前均需要pull 一次代码,修复冲突后才能mr到dev 分支
  • develop和master分支,需要设置为protected branch,杜绝直接commit和merge代码
  • release分支,只做bug 修复,bug修复完后,发布上线,同时要将修复的代码 mr 到dev
  • hotfix分支,线上出现bug需要进行紧急修复,可以从master 拉一个hotfix分支,修复后及时mr 到master 和 dev 分支;线上出现重大bug,或者bug一时难以修复,需要基于上一个tag进行回滚操作。

产品发布流程 - 基于git flow工作流

git-flow

(1)(2)(3)步骤说明

(1)上测试环境,feature 通过merge request 到dev:

  • 在 MR 前,需要从dev 作 pull 操作
  • 在 MR 前,需要功能自测 ,核心服务通过unit test
  • MR 过程中需要assign to peer developer 作 Peer review,双方均需对此次mr 负有责任;Code Reviewer之Peer Review,审查代码逻辑错误,建议更好的实现
  • MR 完成后,基于dev 分支 发布到测试环境;(可以手动,也可以自动)
  • 发布到测试环境后,由QA&UI 负责校验 任务是否达到DoD标准,未能通过检验,返回给研发进行修改

(2)上预发布环境,从dev 发起 merge request 到release:

  • 在MR前,需要当前sprint 内所有task 均达到DoD标准,所有bug fixed
  • 在MR前,需要QA/Tester通过对测试环境的功能测试、性能测试、兼容性测试
  • 在MR前,需要UI Designer通过对产品进行还原度确认
  • 在MR前,需要由Team Leader/架构师 作 Lead Review,对代码架构进行审查,保证代码的重构与复用
  • 基于release 分支发布到预发布环境;release 分支的改动要在上线前MR回dev和master
  • 发布release,意味着此次sprint 的研发结束,后续的研发 就要算作next release 版本

(3)上生产环境,从release 发起merge request 到 master:

  • 在MR前,需要通过QA/Tester通过All Test Case的回归测试
  • 在MR前,需要需求方/PO confirmed,可以通过sprint review meeting 达成
  • 在MR后,需要基于master分支 建立tag进行备份
  • 发布上线后,做冒烟测试
  • 线上出现重大异常或一时无法修复的异常,需要即可基于上一个的tag进行回滚,修复完成后再重新上线

注意情况:

  • (1)(2)(3)在服务器到位情况下,需要优先配置好jenkins 各个环境的deploy item 配置
  • 上线频率需要控制好,一般约定周二、周四,一旦存在问题可以第二日进行修复

备注

以上流程,适用 多人协作、持续迭代、产品各个环节质量和可用性要求高的情况;对于简单项目/对产品可用性要求不高的项目可以在流程上做适当精简分支;具体操作:

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

推荐阅读更多精彩内容

  • 这篇博文是自己在学习git过程中的思考总结。本文仅仅代表个人的看法,如有不妥地方还请本文文末留言。 😊 原文链接g...
    Ming_Hu阅读 1,048评论 4 18
  • 1.GitHub 有什么用 学习优秀的开源项目开源社区一直有一句流行的话叫「不要重复发明轮子」,某种意义上正是因为...
    Clemente阅读 1,422评论 1 14
  • 嗨!小伙伴们,大家好! 欢迎关注《无戒365极限挑战营》第四期月征文,非常感谢各位简书作者与365极限挑战营学员的...
    一句情话去旅行阅读 1,421评论 42 45
  • 《忆》——蓝风 有些记忆,不再曾经;有些人,不再过去;有些事,不仅仅当今; 曾经的我,活在过去;如今的我,乐在现在...
    是蓝风吖阅读 166评论 0 0
  • 我是北方人,北京其实离我并不远,现在火车动车也就六、七个小时,快车十个小时,飞机两个小时也就到了,随着科技的快速发...
    梁山的洛奇阅读 459评论 0 1