Git 设置分支保护实现 CodeReview 卡点

From：https://blog.csdn.net/crisschan/article/details/100922668

GIT 是一个分布式版本控制系统的软件，主要用来控制代码的版本。所谓分布式也就是每一个 git 的客户端都有一份完成的代码库，这样如果中央服务器出现问题，代码也会在各个开发者的电脑上有备份。（本文以下内容以 GitLab 为例）

GitFlow 模式将代码和环境对应

[外链图片转存失败(img-kccgQ5lw-1568695938834)(https://i.loli.net/2019/09/17/TVxgaeYwQN2rMf9.png)]

GitFlow 模式的各分支说明

• 1) master

- 主分支 , 产品的功能全部实现后 , 最终在 master 分支对外发布

- 该分支为只读唯一分支 , 只能从其他分支(release/hotfix)合并 , 不能在此分支修改

- 另外所有在 master 分支的推送应该打标签做记录,方便追溯

- 例如 release 合并到 master , 或 hotfix 合并到 master

• 2) develop

- 主开发分支 , 基于 master 分支克隆

- 包含所有要发布到下一个 release 的代码

- 该分支为只读唯一分支 , 只能从其他分支合并

- feature 功能分支完成 , 合并到 develop(不推送)

- develop 拉取 release 分支 , 提测

- release/hotfix 分支上线完毕 , 合并到 develop 并推送

• 3) feature

- 功能开发分支 , 基于 develop 分支克隆 , 主要用于新需求新功能的开发

- 功能开发完毕后合到 develop 分支(未正式上线之前不推送到远程中央仓库

- feature 分支可同时存在多个 , 用于团队中多个功能同时开发 , 属于临时分支 , 功能完成后可选删除

• 4) release

- 测试分支 , 基于 feature 分支合并到 develop 之后 , 从 develop 分支克隆

- 主要用于提交给测试人员进行功能测试 , 测试过程中发现的 BUG 在本分支进行修复 , 修复完成上线后合并到 develop/master 分支并推送(完成功能) , 打 Tag

- 属于临时分支 , 功能上线后可选删除

• 5) hotfix

- 补丁分支 , 基于 master 分支克隆 , 主要用于对线上的版本进行 BUG 修复

- 修复完毕后合并到 develop/master 分支并推送 , 打 Tag

- 属于临时分支 , 补丁修复上线后可选删除

- 所有 hotfix 分支的修改会进入到下一个 release

GitFlow 主要的工作流程

代码仓库的 Owner 设置 master 分支是保护分支，

• 1) 有新的 feature 要开发的时候，首先从 master 拉取第一个 develop 分支，develop 分支名就是 dev。

• 2) 从 dev 拉取 feature 分支进行编码开发(多个开发人员拉取多个 feature 同时进行并行开发 , 互不影响)，feature 分支命名规范：feature- XX(XX 是一个唯一标示)

• 3) feature 分支完成后 , 合并到 dev，合并后择删除当前 feature。

• 4) 从 dev 拉取 release 分支进行提测 , 提测过程中在 release 分支上修改 BUG，release 分支名字是 release。

• 5) release 分支上线后 , 合并 release 分支到 dev/master 并推送合并之后删除当前 release 分支。

• 6) 上线之后若发现线上 BUG , 从 master 拉取 hotfix 进行 BUG 修改。hotfix 分支命名规范：hotfix-XXX（XXX 是一个唯一标示)。

• 7) hotfix 通过测试上线后 , 合并 hotfix 分支到 dev/master 并推送，合并之后 , 删除当前 hostfix

• 8) 当进行一个 feature 时 , 若 dev 分支有变动 , 如其他开发人员完成功能并上线 , 则需要将完成的功能合并到自己分支上即合并 dev 到当前 feature 分支。

• 9) 当进行一个 release 分支时 , 若 dev 分支有变动 , 如其他开发人员完成功能并上线 , 则需要将完成的功能合并到自己分支上即合并 dev 到当前 release 分支 (因为当前 release 分支通过测试后会发布到线上 , 如果不合并最新的 dev 分支 , 就会发生丢代码的情况)。

Git 的分子保护

[外链图片转存失败(img-CfzADDYw-1568695938859)(https://i.loli.net/2019/09/17/4wPgvOm72Q9zT8K.png)]

在 Git 的分支合并过程中支持方式，一种是在本地将 source branch 合并到 target branch，然后再切换到 target branch 后将 target branch push 到远端 target branch。另外一种是将本地的 source branch push 到远端的 source branch，然后在 gitlab 上提交一个将 source branch 合并到 target branch 的 merge request。那么为了能够到达我们强制的 CodeReview 卡点，我们将 master branch（也就是生产发布分支）、release branch（也就是提测分支）进行保护，不能接受直接的 push request，只能通过提交 merge request，并有架构师或者技术负责人进行 CodeReview 通过后，完成 Merge。那么如何完成 Git 的分支保护呢？

首先进入对应的代码仓，然后点击 Settings 下的 Repository Settings 选择 Protected Branches 选项。

限制了 develop 分支，develop 分支、release 分支、以及 master 分支只能通过 merge request 的方式合并，不可以直接的 push 代码，同时设置了需要 Master 进行合并的请求的 code review 后点击完成后完成合并。（这里面的 Master 就是开发架构师或者技术负责人等角色）

提交一个 Merge Request

点击 merge requst 菜单，然后新建一个 merge request

[外链图片转存失败(img-8ny2Y1VP-1568695938875)(https://i.loli.net/2019/09/17/jWgx1k4VF89UqQt.png)]

然后选择对应的 source branch 和 target branch 后，点击下一步：

[外链图片转存失败(img-sjlwYYtQ-1568695938880)(https://i.loli.net/2019/09/17/caKZCW52pLyX8kr.png)]

进入后输入相关内容后，点击提交合并请求：

[外链图片转存失败(img-nIi7WDl1-1568695938881)(https://i.loli.net/2019/09/17/Jr698w4GeMaXysZ.png)]

[外链图片转存失败(img-81SfDzqW-1568695938887)(https://i.loli.net/2019/09/17/PHUiSv247zWuNJR.png)]

其中（出去如下部分以外都选择默认值或者为空）：

|操作项|说明|

|---|---|

|Title|标题|

|Description|描述写清具体包含的 feature|

|Assignee|分配到的人必须为项目内的技术负责人或者架构师|

|Milestone|no milestone|

|Label|no label|

完成后，就等待 code review 过后等待反馈意见。通过后就可以完成合并了。

IDE：Intelj 的 codereview 插件

1、GitLab Access Token

菜单：User Settings->

Access Tokens 进入 Access Token 添加页面

Name 名称，根据自己喜好来即可

Expires at 过期时间，最远可以选择到 10 年后，根据自己需要填写即可

Scopes 范围，这里选择 api 就够用了

创建完成后，麻烦暂时保存 token。因为一旦刷新或者重开页面，token 就不可见了。

2、IntelliJ IDEA GitLab 插件使用

安装以下两个插件即可：

Gitlab Projects：https://plugins.jetbrains.com/plugin/7975-gitlab-projects

Gitlab Integration：https://plugins.jetbrains.com/plugin/7319-gitlab-integration

3、Visual Studio

Visual Studio GitLab 插件：https://marketplace.visualstudio.com/items?itemName=MysticBoy.GitLabExtensionforVisualStudio

4、Visual Studio Code

Visual Studio Code GitLab 插件：https://marketplace.visualstudio.com/items?itemName=jasonn-porch.gitlab-mr

5、Atom

Atom GitLab 插件：https://atom.io/packages/gitlab

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接：http://blog.csdn.net/crisschan