Fork me on GitHub

CodeReview环境搭建

CodeReview环境搭建

雷数科技使用Phabricator(点击查看官方文档)作为codeReview的工具。在我们使用git做协同开发的时候,所有要入库的代码都必须先过CR,至少有一个人查看代码,并且accept之后,方可提交到开发分支(develop)或者bug-fixes分支上。

这里介绍一下CodeReview的环境搭建以及简单的使用方法。

CR环境搭建

  1. 搭建git环境,将git加到环境变量中,windows下推荐安装gitbash
  2. 首先在我们的CR平台上注册账号,用户名为自己姓名拼音的全拼,注册完成后,修改realName为自己的中文名称(在profile里面修改),如顾柯栋,用户名为gukedong,realName为顾柯栋。
  3. 创建一个文件夹,名字随意,英文就好,然后把一下两个工程clone到该文件夹下。

    1
    2
    somewhere/ $ git clone https://github.com/phacility/libphutil.git
    somewhere/ $ git clone https://github.com/phacility/arcanist.git
  4. 在你的机器中配置php环境,下载php7.1版本的非线程安全模式,下载链接,下载到本机中,将php.ini-development重命名为php.ini, 并将php.ini-production文件删除。

  5. 打开php.ini将;extension=php_curl.dll前面的分号去掉;将; extension_dir = "ext"前面的分号去掉,ext改为下载 的php的ext的绝对路径
  6. 将arcanist的bin目录加入到环境变量中,执行acr -h是否查看arc命令是否正常(新配的环境需要新开一个命令行窗口) ;
  7. 在你的git项目(已关联远程仓库)根目录下创建配置文件(如果已经有,请忽略),配置文件名.arcconfig,配置文件里面配置内容如下:

    1
    2
    3
    {
    "phabricator.uri" : "http://cr.thundersdata.com:26170"
    }
  8. 安装 arc 证书

    1
    2
    $ cd yourproject/
    yourproject/ $ arc install-certificate

点击命令行窗口的url,拿到网页上的token粘贴到命令行窗口。

  1. 修改arc的默认编辑器为vim(gitbash 自带)
    1
    $ arc set-config editor vim

arc 使用教程

  1. 当我们需要创建一个revision(即一个codeReivew请求)时,

    • 如果当前分支已经关联了远程的一个分支(不推荐直接在关联dev和master的分支上开发,应该在自己的本地分支上开发),在git项目目录下执行arc diff即可,当前的本地版本就会同远程分支进行比较;—不推荐
    • 如果当前分支是你自己创建的本地分支(使用 git checkout -b 快速创建一个分支并且切换过去),需要同远端的dev分支做表(一般是dev分支),可以使用arc diff dev指定比较的分支(这里是dev分支); —推荐使用这种方式
  2. 当我们对之前创建对revision分支做更新的时依然使用arc diff 即可,

    • 如果需要重新创建一个revision(比如当你要修复原来的某个bug,应该在新的本地分支上做开发),使用arc diff --create即可创建新的revision;
    • 如果你当前有几个revision还没有accept以及push到远端,你可以使用arc diff --update -D revisionId 的方式指定更新某个具体的revision。
  3. 当你的revision被accept之后,你需要提交代码,可以直接执行arc land 远端分支的方式,它会把你的代码提交到指定的分支,并且关闭该revision,删除你本地分支(如果没有关联远端分支的话),如arc land dev 会将本地分支代码提交到远端分支上。如果你本来就是在跟远端分支关联的dev分支上开发的话,执行arc land即可,当然我们不推荐这么做。

  4. 执行arc命令的时候,带上--trace会把你的命令执行过程打印出来,方便查看问题在哪里。

以上,希望能对你有所帮助。

您的支持将鼓励我继续创作!