Gerrit-快速指南

什么是Gerrit？

Gerrit是一个开源的、Web界面化的代码审查工具，特别适用于管理Git版本库，并通过基于Web的代码审查工作流程来审查提交。Gerrit可用于任何Git代码库，但它在Android、WebKit、OpenStack等领域被广泛使用。

安装Gerrit

Gerrit可以在Linux、Windows、macOS平台上运行。在Ubuntu下使用apt-get命令可以安装Gerrit：

sudo apt-get install gerrit

安装完成后，可以使用如下命令启动Gerrit服务器：

sudo /etc/init.d/gerrit start

配置Gerrit

安装完成后需要对Gerrit进行一些配置工作，其中包括设置管理员账户、数据库、邮件服务器等。配置信息保存在Gerrit的配置文件中，可以通过Web界面或修改配置文件来修改。

设置管理员账户

管理员账户用于Gerrit的维护和管理，可以通过如下方式创建：

java -jar gerrit.war init --batch --install-all-plugins --no-auto-start

配置数据库

Gerrit默认使用H2数据库，但也可以使用MySQL或PostgreSQL。配置文件为/var/gerrit/review_site/etc/gerrit.config，添加如下配置：

[database]
type = postgresql
hostname = localhost
database = gerritdb
username = youruser
password = yourpassword

配置邮件服务器

邮件服务器用于发送邮件通知和代码审查结果。配置文件为/var/gerrit/review_site/etc/gerrit.config，添加如下配置：

[sendemail]
from = yourname <youremail@example.com>
smtpServer = yoursmtp.example.com
smtpUser = youremail@example.com
smtpPass = yourpassword
smtpEncryption = ssl
smtpPort = 465

使用Gerrit

创建项目

创建新项目时，需要在自己的Git服务器或者GitHub等Git托管平台上创建一个新的Git仓库，并在Gerrit上创建相应的Project：

ssh -p 29418 youruser@yourserver gerrit create-project --name yourproject

提交变更

在创建新的分支或修改代码后，通过以下命令将修改提交到Gerrit：

git push ssh://youruser@yourserver:29418/yourproject HEAD:refs/for/master

这将会把当前分支的HEAD提交到远程仓库的master分支上（如果需要提交到其他分支，请修改refs/for/master参数）。管理员和其他开发者将会收到一封邮件，通知他们需要审核这个提交。审核者在Gerrit的Web界面上对提交进行审核。

代码审查

审核者可以对提交的代码进行评论，指出其中的错误。开发者可以根据评论修改代码，并重新提交到git仓库。这个过程会不断重复，直到代码达到质量要求为止。审核者可以将审核结果反馈给开发者，让其进行修正。修改完成后，再次提交到Gerrit进行审核。Gerrit审查工作流程如下图所示：

总结

Gerrit是一个非常优秀的代码审查工具，可以帮助开发者和项目管理者大大提高代码质量和协作效率。在使用Gerrit时，需要注意以下几点：

• Gerrit需要一定的安装配置工作才能使用。
• 提交变更时可以添加提交信息，便于审核人员了解提交的内容。
• 通过审核的代码需要由管理员Merge到主分支上，开发者无法直接合并自己的代码。
• 审核结果以邮件形式通知相关人员，在审核时需要密切关注邮件信息。
• 审核者需要耐心查看代码，指出其中的问题，同时给出修改的建议。