GitLab分支管理规范

8,238 阅读6分钟

本规范用于描述日常研发流程中关于GitLab上代码分支使用的规则,大家共同严格遵守规范,避免出现分支管理混乱现象,保证日常的发版上线工作顺利进行。https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2017/11/30/1600b046a716c223~tplv-t2oaga2asx-image.image

  • Workspace:工作区,平时我们写代码的地方。
  • Index:暂存区,写完代码后让它变成的待提交的状态。
  • Repository:本地仓库,提交暂存区的代码到这里,记录进入代码本地管理。
  • Remote:远程仓库,将本地仓库的修改的代码提交到远程,可以供远程协作的人下载。

分支管理规范主要遵循gitflow的分支管理流程,见下图:

master分支
只存线上的代码,只有确定可以上线时的才合并到master上,并且在master的基础上打Tag。

develop分支

初次创建develop时,需要从master分支拉取,保持开发时代码和线上最新的代码相同。develop分支是在开发时的最终分支,具有所有当前版本需要上线的所有功能。

feature分支

  • 用于开发功能的分支,必须从最新的develop分支代码拉取。分支命名基本上是feature/xxxxx(和功能相关的名字)。
  • 不强制提交到远程仓库,可以本地创建。
  • 比如,我要开发登录功能,我从develop分支的最新代码创建新分支命名为feature/login,然后切换到这个新分支开始开发。开发完成后,测试差不多完成,合并到develop分支。

release分支

  • 当develop分支已经有了本次上线的所有代码的时候,并且以通过全部测试的时候,可以从develop分支创建release分支了,release分支是为发布新的产品版本而设计的。
  • 通过在release分支上进行这些工作可以让develop分支空闲出来以接受新的feature分支上的代码提交,进入新的软件开发迭代周期。
  • 在这个分支上的代码允许做小的缺陷修正、准备发布版本所需的各项说明信息(版本号、发布时间、编译时间等等)。
  • 比如,此次1.0版本所有的功能版本都已经合并到了develop上,并且所有测试都已经通过了测试,那我就创建新的release分支release/v1.0。切换到新分支,修改最新的版本号等,不允许大的更改。

hotfix分支

  • 当线上出现bug需要紧急修复时,从当前master分支派生hotfix分支。
  • 修改线上bug,修改完成后合并回develop和master分钟。
  • 比如,在线上v1.0登录功能出现问题,我从master拉取代码创建新的分支hotfix/v1.0_login,修改完成后合并到master和develop上。

正常的业务需求流程:

  1. 当接收到正常的业务需求时,需要约定一个大的发布版本(一次迭代)以及这个发布版本包含的多个jira任务,一个发布版本必须在一个时间点上发布;如果jira上的任务粒度太大,则需要拆分细化成更小的jira子任务(工作量在1~2人日为准,最好控制在一天以内)。
  2. 以develop为基准创建一个分支,分支名称为“feature-jira编号-开发人员姓名全拼”,如“feature-ONC-21-lishaohua”,jira任务ONC-21的所有开发工作都在feature-ONC-21-lishaohua分支上进行,所有开发过程的commit message需要填写具体的开发内容。
  3. 开发及单元测试工作完成后创建merge request合并到develop分支,合并请求消息同样需要复制jira的内容描述以及具体的开发内容。
  4. 开发人员的自测工作基于合并后的develop分支代码进行,如果这个发布版本所有jira任务全部自测通过后,基于测试通过的develop分支创建一个release分支,分支名称为“release-版本号”,如“release-ctrip1.0”,测试人员基于release分支进行测试。
  5. 测试人员继续在新建的release分支上进行回归测试和验证,如果存在bug直接在该分支修改并合并到develop分支;如果验证通过则准备生产上线,
  6. 生产上线时将release代码合并到master分支,并打tag,tag名称为“tag-版本号”,从master打包上线。

以上是一个正常的迭代开发流程。

线上紧急bug修复流程:

  1. 当发现线上bug需要紧急修复时(开发人员需要确保bug修复已经在jira录入),需要以master分支为基准创建一个hotfix分支,分支名称为“hotfix-jira编号-开发人员姓名全拼”;
  2. bug修复代码直接在新建的hotfix分支上提交,commit message需要填写具体的开发内容。测试人员直接在hotfix分支测试
  3. 测试通过后,开发人员同时请求合并到master分支和develop分支,合并请求消息同样需要复制jira的任务描述以及具体的开发内容。
  4. 生产上线时将hotfix代码合并到master分支,并打tag,tag名称为“tag-版本号-jira编号”,从master打包上线。

以上是一个紧急bug修复的流程。

高优先级开发任务流程:

  1. 如果在其他发布版本或迭代在开发中,而优先级更高的迭代需要同时进行,则需要特别注意。在创建feature分支时,要确保develop分支和master分支时一致的没有被未上线甚至未测试的代码污染过的,如果是则直接以develop分支为基准创建新的分支,命名规范如同正常的业务需求流程;如果develop分支上已经有其他未上线分支的代码且该分支代码上线优先级较低,则不能以develop分支为基准创建分支,需要以master分支为基准创建分支。
  2. 当更高优先级feature功能开发和自测完成后,需要上测试环境,这时,需要以master分支为基准创建一个release分支,release分支名称为“release-版本号”,所有较高优先级的feature分支合并到高优先级的release分支上,并在该分支进行测试。
  3. release分支测试通过后,合并到master分支准备上生产,同时release合并到develop分支;master分支生产上线后打tag,tag名称为“tag-版本号”。


最后关于几点需要强调一下:

  1. 长期的使用的分支有两个master分支和develop 分支,其他的辅助分支hotfix分支、feature分支以及release分支都是临时分支,其生命周期在合并到develop或master上之后就基本结束,所以大家要养成良好的习惯,在分支生命周期结束之后尽快删除掉,以免堆积太多的分支而导致混乱;
  2. 大家开发过程中要勤提交、勤合并,原则上一些方法级别、类级别或单元测试级别的修改可以发起一次提交,提交的commit message写明工作的内容,一个feature或bug的自测完成可以发起一次merge request,merge request的message内容要复制jira任务的描述以及具体的开发工作内容描述,切勿堆积很大的工作量才发起合并