Skip to content

自动检测gerrit中每次提交的代码是否符合《阿里巴巴开发手册》规范,根据规范的不同等级,给予相应的CodeReview分数

Notifications You must be signed in to change notification settings

gao715108023/gerrit-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

auto-codereview-tool

自动检测gerrit中每次提交的代码是否符合《阿里巴巴开发手册》规范,根据规范的不同等级,给予相应的CodeReview分数

环境需求

  • JDK 1.8+
  • Maven 3

扫描规则

工具检测规则基于PMD (https://github.com/pmd/pmd)实现了 阿里巴巴Java开发手册(终极版).pdf中的49个规则.

快速开始

1. 下载源代码

git clone https://github.com/gao715108023/gerrit-tool.git

2. 在/usr/local目录下创建文件夹CodeReview

sudo mkdir -p CodeReview
#给CodeReview增加读写权限
chmod -R 777 /usr/local/CodeReview

将源代码中resources下的rulesets文件夹拷贝至/usr/local/CodeReview目录下

3. 配置filters/filter-dev.properties

# ******************** log 相关配置 ********************
#日志输出等级
log.level=INFO
#日志输出目录
log.file=/usr/local/CodeReview
#日志输出类型,STDOUT-代表控制台输出;InfoFile-代表文件输出
log.appender=STDOUT
#gerrit地址
gerrit.url=http://127.0.0.1
#gerrit用户名
gerrit.user=gaochuanjun
#gerrit密码
gerrit.password=123456
#rule目录
rulesets.path=/usr/local/CodeReview/rulesets
#review频率,单位为秒
review.sleep.second=60

4. 配置review-ignore

review-ignore文件是用来配置忽略哪些源代码不需要遵守《阿里巴巴开发手册》规范,刚开始可以直接使用默认配置。

/dao/
pom.xml
resources
test
.gitignore
webapp
Example

5. 编译源代码

mvn clean install -DskipTests -P dev

6. 拷贝target目录下的target/gerrit-code-review.zip包至/usr/local/CodeReview目录下

7. 解压缩

unzip gerrit-code-review.zip

8. 启动

执行service.sh

./service.sh start

日志中输出如下信息则代表启动成功!

gerrit code review service server started

About

自动检测gerrit中每次提交的代码是否符合《阿里巴巴开发手册》规范,根据规范的不同等级,给予相应的CodeReview分数

Resources

Stars

Watchers

Forks

Packages

No packages published