IDEA CodeReview 插件
目前,IDEA官方没有给出gitlab的官方code review 插件。有2个比较好用的开源插件,分别是:
| 插件名称 | 优点 | 缺点 |
|---|---|---|
| merge-request-integration-ce | 在idea中可以方便的查看code review 的评论并且可以针对这些评论进行修改和解决。 | 无法发起一个merge request |
| Gitlab Projects | 可以单独发起merge request,也可以查看到merge request中所有的代码评审的评论以及提交的代码 | 评论无法对应到绑定的代码上。无法针对性的检查或者修改 |
因此建议使用 Merge Request Integration CE 插件来做code review 。发起merge request可以在gitlab上单独操。也可以安装Gitlab Projects,专门来创建新的merge request ,Gitlab Projects的安装与操作可以参考文档:ken.io/note/gitlab… 。下面是Merge Request Integration CE插件的安装与配置:
1.安装插件
点击preference--》plugins;在marketplace中搜索 Merge Request Integration CE 插件,点击安装。安装后如图所示:
2.配置参数
点击preference--》other Settings--》 Merge Request Integration CE --》Gitlab;配置gitlab地址和你的访问token 如下图所示:
其中private token 是在gitlab的setting中获取的。获取路劲如下:点击右上角头像--》User Settings--》Access Tokens ; 随便填写一个名称(可以用你的账号),Scopes只需勾选api ,然后点击create personal access token。最后获取到的token就是填在上面提到的 private token中的信息了。配置好以后,就可以进行code review了。
3.使用插件
如上图,在重启IDEA以后,点击左下角的图标,选择Merge Request Integration CE。就可以打开Merge Request Integration CE的窗口。
- Genral Infomation: 项目的git信息
- opening MRS:正在打开的MR(Merge Request)
- My MRS: 我提交的MR
- MRS assigned to me : 给我审核的MR。
选中某一个MR,双击 可以进入到本次合并请求中查看具体的细节。如下图所示:
如下图,进入细节以后,有4个tab 。分别是:
- Info : 本次合并请求的基础信息 例如分支合并信息 提交人 提交时间等
- Desciption: 合并请求的描述,也就是在gitlab中创建MR时,填写的Description信息
- Comments: 审核人填写的评论列表,点击对应的评论可以定位到对应的代码,可以进行评论和解决。
- Commits: 本次提交的记录已经修改的文件列表。可以查看有哪些文件修改了,且提交的备注信息是什么,方便审核人员审核。
如果需要开启Code Review。点击最右方的Code Review。可以进入Code Review模式。在每一行代码前都可以查看、修改、评论一个comment.点击“+” 就可以弹出一个新增comment的弹框。弹框上可以进行保存草稿、添加评论、添加回复等操作。 如下图:
点击resolve thead ,表示这个comment标记为解决。当所有的comment被解决以后,可以通知相关人员完成合并。以及解决的comment可以在窗口的左下角点击resolved comments查看;如下图:
当所有comments 被解决以后 gitlab 会发送一个邮件通知给项目管理员,通知他code review已结束,并及时处理MR。