Arcanist CodeReview 使用帮助说明 1.0

公共文档

变更历史

1、Arcanist配置

详细配置说明，可以直接参见官方文档（翻译中文）Arcanist 快速开始

1.1 windows

官方也有针对windows配置的说明，具体见Arcanist 用户指南: Windows，在此教程，提供了快速的配置，主要针对php配置作了相应的处理。

1.1.1 配置hosts文件

由于当前code review处于试运行阶段，先采用直接修改hosts方法支持域名访问。

• 使用管理员权限运行记事本

• 打开hosts文件C:\Windows\System32\drivers\etc\hosts

• 增加hosts配置

192.168.2.213 review.bitnei.cn

1.1.2 下载相关组件

为了快速配置，我们固定将组件存入到E:\review目录（默认的windows命令行可能不支持mv操作，如果不行，直接通过拷贝实现）

#
cd e:
#下载组件，
git clone http://review.bitnei.cn:8080/source/phabriatorConfig.git
# 重命名目录
mv phabriatorConfig e:\review

1.1.3 配置环境变量

将php和arcanist的可执行目录增加到PATH，即：

1.1.4 测试

2 系统简单使用说明

2.1 登录系统

通过浏览器，打开review.bitnei.cn:8080，输入用户名和密码

2.2 修改语言环境

2.3 修改VCS密码

vcs密码即为svn、git的密码，这里不能和登录密码相同。

3 项目配置

要求在项目根目录，创建一个.arcconfig文件(此工作应由工程负责人处理，然后提交到git仓库上)，配置内容如下

{
  "phabricator.uri" : "http://review.bitnei.cn:8080/"
}

4 审核流程

4.1 提交审核

• 通过git add 将新增变更的文件加入到本地缓存

• 通过git commit将变更提交到本地仓库

• 执行arc diff将变更代码提交到phabricator，供审核人员审核

a. 若当前项目存在未增加到本地缓存的文件，会出现这个提示，在这里，我们输入y即可

b. 然后arc会通过调用外部的编辑器（linux和mac默认会调用vi），对提交的审核信息进行编辑，编辑完之后保存，然后关闭编辑器，arc就会自动将审核内容提交

c. 提交成功

d. 查看提交的审查列表

4.2 审核人员审核

• 审核人员打开review.bitnei.cn:8080，登录系统。

• 找到等待审查的内容，点击进入审查（点击代码行，可以增加代码评价）
  
  

• 审核操作，审核通过之后，将变为Accepted
  
  

4.3 提交代码至仓库

• 通过执行arc list查看审核状态,我们会发现状态已经变为Accepted

• 通过运行arc land将代码提交到仓库，按照提示输入身份认证信息，即可以提交到仓库

A 附录

A.1 常见问题

A.1.1 为什么使用arc land之后，不需要再操作git push xxx xxx?

答： arc land已经集成了git push操作

A.1.2 审查不通过之后，开发人员应该如何操作？

答： 开发人员需要根据审查人员反馈的情况，对代码处理之后，重新通过arc diff提交审查即可。

A.1.3 审查通过之后，向仓库推送代码里发送存在冲突，开发人员应该怎么处理

答： 合并之后，要通过arc diff再次发起审核