Gerrit Code Review详解

一、Gerrit Code Review是什么？

Gerrit Code Review是一个基于Git的Web代码审查工具。它提供了一种功能强大的审查方式，可分析提交的代码并允许团队对其进行一系列的评论和修改，最终生成高质量的代码。

通过Gerrit Code Review，代码编辑人员可以将本地分支上的代码提交到Gerrit服务器，然后由团队成员进行代码审查。这个过程中，审查人员对代码进行评级、评论和修改，然后向提交者提供有关代码改进的反馈。最终，Gerrit服务器将评审后的代码集成到主分支。

二、Gerrit Code Review的特性是什么？

1、Git标准化：Gerrit Code Review是基于Git的，遵循了Git相关标准，如提交信息描述和分支名规范等。

2、代码审查工作流：Gerrit Code Review提供了一个完整的代码审查工作流，包括撰写提交说明、任务跟踪、机器人触发、静态代码分析等功能。

3、可自定义的代码审查规则：Gerrit允许你定义自己的代码审查规则，如不允许从特定分支合并、必须使用特定的库或者代码格式等。

4、内置代码审查小组：Gerrit可以为您构建一个团队，管理代码审核人员和修复人员的任务。

5、REST API支持：Gerrit提供REST API，可以通过它与其他工具交互。

三、Gerrit Code Review的安装与使用

Gerrit Code Review的安装需要借助Puppet，而使用则非常简单。

1、安装Gerrit Code Review

首先，需要安装Puppet并将其配置为能够与您的服务器进行通信。接下来，请遵循以下步骤：

// 安装Gerrit Code Review
sudo apt-get install -y gerrit

// 生成ssh密钥对
ssh-keygen -t rsa -N "" -f ~/.ssh/id_rsa

// 将生成的公钥复制到Gerrit服务器上
scp ~/.ssh/id_rsa.pub user@server:/tmp/

接下来，可以在位于/tmp/的服务器上使用SSH将公钥添加到Gerrit Code Review的访问控制列表中：

ssh user@server
sudo su - gerrit2
ssh-keygen -t rsa -N "" -f ~/id_rsa
cat /tmp/id_rsa.pub | ssh -p 29418 user@server "gerrit create-account --ssh-key - dev"

2、使用Gerrit Code Review

使用Gerrit Code Review，您需要在本地分支上提交需要审核的代码，并将其推送到服务器。

// 克隆Gerrit服务器的repository
git clone ssh://user@server:29418/[project_name].git
cd [project_name]
//例如，git clone ssh://dev@localhost:29418/example.git

// 提交您的本地代码更改到Gerrit服务器上，进行审核
git push origin HEAD:refs/for/master

此时可以登录Gerrit页面查看代码审核的结果。

四、Gerrit Code Review的扩展与集成

作为一个开放源代码的工具，Gerrit Code Review可以与其他工具和服务创建集成，例如Jenkins、Gitlab、Jira和Github等。

1、与Jenkins集成

Gerrit Code Review可以与Jenkins集成，使得您可以在进行代码审查后进行自动化测试和部署。

// 安装Gerrit Trigger插件
Jenkins -> Manage Jenkins -> Manage Plugins -> Available -> Gerrit Trigger

// 配置Gerrit参数
Jenkins -> Manage Jenkins -> Configure System -> Gerrit Trigger -> Server列表

// 配置Jenkins Job
Jenkins -> [Project] -> Configure -> Build Triggers -> Gerrit Trigger -> 监听Gerrit操作

2、与Gitlab集成

通过与Gitlab集成，您可以实现Gerrit对Gitlab的认证和授权，使得在Gitlab平台上进行的提交、修改和合并请求都将进入Gerrit审核流程。

// 启用Gerrit服务的外部认证
修改/etc/gerrit.config, 增加如下内容
[auth]
		type = HTTP
		projectOwnerGroups = Administrators

sudo /etc/init.d/gerrit restart


// 配置Gitlab参数
1. 认证配置
Admin -> Applications -> New Application -> Fill the fields -> 回调URL填:http://gerrit.example.com:8080/login/
2. 项目访问控制配置
Project -> Settings -> Integration -> Services -> Gerrit Code Review

3、与Jira集成

通过与Jira集成，您可以直接从Gerrit Code Review跟踪代码的bug和故障问题，以及将Jira提供的问题跟踪集成到代码审查流程中。

// 安装Jira插件
插件列表 -> 已安装插件 -> 找到"JIRA Software Aplications Plugin" -> 保存并启用

// 配置Jira参数
重新启动Gerrit服务并按照以下步骤进行配置：
Gerrit -> 项目页面 -> Project-Settings -> Integrations -> Jira and Jira Software -> Server settings

4、与Github集成

通过与Github集成，您可以将Github上的代码库复制到Gerrit服务器，并将其视为Gerrit托管的项目。

// 安装Github插件
Jenkins -> Manage Jenkins -> Manage Plugins -> Available -> Github -> 安装

// 配置Github相关信息
Jenkins -> Manage Jenkins -> Configure System -> Github -> Add a Github server -> 配置API token和Credentials

// 配置Jenkins Job
Jenkins -> [Project] -> Configure -> Source Code Management -> Git -> Repository URL填GitHub的项目地址

五、总结

Gerrit Code Review是一款功能强大的开源代码审查工具，它提供了一个完整的工作流程和自定义的审查规则，硬实力上极大提高了代码质量，具有广泛的扩展与集成能力。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/249641.html