基于GitLab的Code Review教程


一、前言

JetBrains开发了几乎覆盖所有主流编程语言的IDE

JetBrains Tools目前覆盖的主流语言有:C/C++、C#、DSL、F#、Go、Groovy、Java、JavaScript、TypeScript、Kotlin、Objective-C、PHP、Python、Ruby、Scala、SQL、Swift、VB.NET(排名不分先后)

https://gitlab.com/ken-io/test

image

新建分支:
release(from master)
develop-test(from master)、
feature-ken-test(from develop-test)

  • Protected Branches 配置

为了保证必须以Merge的方式变更develop分支、release分支、以及master分支,我们需要对Push以及Merge权限进行限制

菜单:Settings->Repository Settings然后展开Protected Branches选项
https://gitlab.com/ken-io/test/settings/repository

image

这里,我们限制分支,所有的开发人员对develop分支、release分支、以及master分支均无Push权限,只能以Merge方式合并到对应分支,而且只有Maintainers(Masters)组的用户有Merge权限。

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

  • 安装GitLab插件

Settings->Plugins 进入Plugins管理页

image

点击Browse repositories并搜索gitlab

image

安装Gitlab Projects以及Gitlab Integration,然后重启IDE生效

  • 配置GitLab

在Settings界面搜索GitLab Settings

image

填写GitLab Server Url、Access Token,然后点击Add New One完成添加
如果是私有化部署的GitLab,换成对面的域名或者IP+Port即可

  • Create Merge Request

Clone项目feature-ken-test分支到本地,变更后push到origin。
然后在菜单中选择:VCS->Git->Git Lab-> Create Merge Request

image

这里相当于我们在GitLab网页上进行创建操作,只不过少了一些选项,也暂不支持Approvers相关选项。
选择目标分支,被分配的人,填写好Title、Description然后点击OK即可。
Merge Request创建完成后,插件会在右下角提示,点击链接即可跳转到Merge Request页面

如果提示冲突,请先将目标分支代码合并到当前分支

  • Merge Request Manage

项目成员在菜单中选择:VCS->Git->Git Lab-> List Merge Request

image

在这里可以看到待处理的Merge Request,选中后点击Code Review就可以呼出Merge Request操作面板

image

按钮说明
Diff 查看所有变更文件及差异
Comments 查看、添加评论
Assign to me 将跟进人指给自己
Merge 执行Merge
  • Merge Request Diff

Diff界面说明:

image

左侧是本次合并的commit记录,右侧是本次合并的文件。双击对应文件即可查看差异明细

image

  • Merge Request Comments

image

Comments界面可以查看指定Merge Reuqest评论信息,也可以添加评论,双击可以查看完整评论内容。
但是不支持针对代码行发起讨论、对讨论标记为已解决等。


GitLab插件还是更适用于Create Merge Request、或者对于较为简单的提交进行Code Review。如果需要讨论等功能,还是建议在GitLab页面上进行操作

https://marketplace.visualstudio.com/items?itemName=MysticBoy.GitLabExtensionforVisualStudio

  • Visual Studio Code

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

  • Atom

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

GitLab安装部署教程:https://ken.io/note/centos7-gitlab-install-tutorial


以上,如有疑问,欢迎联系我:https://ken.io/home/about

  • 本文首次发布:2018-08-20
  • 本文原文链接:https://ken.io/note/gitlab-code-review-tutorial