通过 git-repo 提交代码评审

单仓库代码评审

大多数用户参与的项目是一个代码仓。对于单仓库操作, git-repo 提供了如下命令扩展:

  • git peer-review 或 git pr: 创建代码评审。

  • git bandon: 清理当前完成评审发起的分支。

  • git download: 下载评审的代码到本地。

git peer-review

git-repo 针对常用的单仓库的工作区,提供了快捷的创建代码评审的命令:git peer-review。该命令可以简写为 git pr 或者 git review

1. 创建代码评审

使用 git peer-review 命令创建代码评审的步骤如下:

1.1 克隆远程仓库到工作区

克隆远程仓库到本地工作区,例如克隆本 git-repo 网站的仓库。 (如果工作区中已经存在该仓库,则忽略此步骤。)

$ git clone git@codeup.aliyun.com:codeup/codeup.git

切换到本地仓库的工作区:

$ cd codeup

1.2 创建特性分支

在本地工作区中创建新的工作分支。这个步骤不是必须的,使用当前分支(如 master 分支)也可以。但是如果需要在一个工作区目录切换不同特性的开发,则创建分支是需要的,否则多个特性的代码可能混在同一个代码评审任务中,或相互覆盖。

$ git checkout -b topic1 origin/master

上面命令的两个参数要重点说明一下:

  • 参数 -b topic1 设定了新的工作分支的名称。

  • 最后的 origin/master 参数,则是为了将新建分支和上游的 master 分支建立关联。这个参数很重要,如果忘了添加该参数,则在用 git peer-review 创建代码评审时,会提示补救措施。

1.3 工作区内开发和提交

在工作区中进行代码开发工作,使用标准的 git 命令进行提交。

1.4 发起代码评审

当完成本地开发后,需要将代码推送到上游仓库,并创建代码评审时,执行如下命令:

$ git pr

该命令的参数有很多,可以设置代码评审需要的各项参数,例如:

  • 指定评审者和关注者。多个用户邮箱之间可以用(半角)逗号分开。

$ git pr --reviewers jack@gmail.com,rose@gmail.com --cc carle@gmail.com
  • 设定代码评审处于草稿状态,可以发表评审意见,但是不能合入。

$ git pr --draft

如果希望退出草稿状态,可以在“合并请求”详情内,点击标题进行编辑,删除标题的”WIP“前缀后,保存即可退出草稿状态。如果当前分支相比远程分支没有新提交,则不会创建代码评审,显示提示信息如下:

$ git pr
    NOTE: no branches ready for upload

如果已经发起过一次代码评审,且之后没有代码改动,也不会执行。

显示的提示信息如下:

$ git pr
    NOTE: no change in project . (branch topic1) since last upload
    NOTE: no branches ready for upload

如果本地分支未跟踪某一个远程分支,则 git peer-review 命令不知道该向哪个远程分支发起代码评审。必须设置本地分支和远程分支的跟踪,才可以发起代码评审。命令报错信息如下:

$ git pr
    FATAL: upload failed: cannot find tracking branch
    Please run command "git branch -u <upstream>" to track a remote branch. E.g.:
        git branch -u origin/master

参照提示信息中的命令,建立工作区本地分支和远程分支的跟踪关系。

1.5 代码评审的编辑界面

输入 git pr 命令后,会打开一个编辑器,内容是此次代码评审的各项可定制的参数,内容如下:

##############################################################################
    # Step 1: Input your options for code review
    #
    # Note: Input your options below the comments and keep the comments unchanged
    ##############################################################################
    # [Title]       : one line message below as the title of code review
    # [Description] : multiple lines of text as the description of code review
    # [Issue]       : multiple lines of issue IDs for cross references(暂未支持)
    # [Reviewer]    : multiple lines of user names as the reviewers for code review
    # [Cc]          : multiple lines of user names as the watchers for code review
    # [Draft]       : a boolean (yes/no, or true/false) to turn on/off draft mode
    # [Private]     : a boolean (yes/no, or true/false) to turn on/off private mode(暂未支持)
    ##############################################################################
    # Step 2: Select project and branches for upload
    #
    # Note: Uncomment the branches to upload, and not touch the project lines
    ##############################################################################
    #
    # project ./:
       branch topic1 ( 3 commit(s)) to remote branch master:
    #         03c01e211122b49fe05f48e08fd3e1dd1c52e57e
    #         ec78989440697fbc13bfbd3ea082fe9b3fc5f2d7
    #         4e599aa284ed64ba12ba1b5b06fbbd3199846434

其中以字符 "#" 开始的行是注释,不要改动注释行,因为 git-repo 要根据注释行的内容判断用户输入内容用于更改哪项代码评审的参数设置。 例如:

  • 在 "# [Title]" 行的下面添加的内容,成为代码评审的标题。默认用提交说明的标题作为代码评审标题。

  • 在 "# [Description]" 行的下面添加的内容,成为代码评审的详细描述。默认用提交说明的内容作为代码评审的详细描述。

  • 在 "# [Issue]" 行的下面如果添加 Issue ID,则将代码评审和问题之间的建立关联,此功能目前还在开发中,暂未支持。

  • 在 "# [Reviewer]" 行的下面添加代码评审者在云效已绑定的主邮箱,一个一行,或者用逗号分隔。

  • "# [Cc]" 行预留支持代码评审的关注者,此功能目前还在开发中,暂未支持。

  • 在 "# [Draft]" 行的下面如果输入 yes,则表明要创建一个草稿模式的代码评审。

  • 在最下面的 "Step 2" 区域,显示当前项目将要上传到远程仓库的分支和提交列表。检查提交列表,如果不想创建此次代码评审,则将 "branch ..." 的行注释掉,或者删掉,则此次创建代码评审的任务终止。

保存内容,退出编辑器,则开始向服务端推送代码,并开始代码评审的创建。

编辑的内容会以模板的方式保存,以便在下一次执行 git peer-review 时复用。

注意

:目前Issue关联、关注者和Private模式还在开发中,近期将会上线,敬请期待!

1.6 完成代码评审的创建

git peer-review命令执行完毕后,显示代码评审创建成功的消息,示例如下:

remote: +-----------------------------------------------------------------------------+
    remote: | Merge Request #888 was created or updated.                              |
    remote: | View merge request at URL:                                                  |
    remote: | https://codeup.aliyun.com/codeup/codeup/merge_request/888 |
    remote: +-----------------------------------------------------------------------------+
    To ssh://codeup.aliyun.com/codeup/codeup.git
     * [new branch]      topic1 -> refs/for/master/master

注意到提示信息中包含创建成功的代码评审的 URL 地址,通过浏览器访问该地址,显示创建好的代码评审。

1.7 服务器端仓库的变化

通过命令行工具在服务器端创建代码评审,服务端不会创建新的分支,但是为了方便用户远程下载评审代码,仓库中生成了一个特殊的引用。

例如上面创建的第 888 号代码评审,会创建包含该评审 ID 号的,名为 refs/merge-requests/888/head 的特殊引用。下载该待评审的代码,可以使用如下命令:

$ git fetch origin refs/merge-requests/888/head
      From codeup.aliyun.com:codeup/codeup
       * branch            refs/merge-requests/1452262/head -> FETCH_HEAD

检出相关代码:

$ git checkout FETCH_HEAD

2. 评审作者重新发送,刷新代码评审

代码评审很少一蹴而就,针对评审者的意见,开发者(评审任务的创建者)往往需要重新上传代码刷新代码评审。对于Codeup上创建的代码评审任务,重复执行 git peer-review 命令即可。

  1. 开发者首先在本地工作区修改代码。

  2. 执行如下命令,向远程仓库推送并刷新代码评审任务:

$ git pr

3. 下载和更新代码评审

除了代码评审的作者,评审者们也可以对评审进行更新,让一个代码评审的相关人员可以协同工作,提升效率。

例如,一个用户作为上面创建的第 888 号代码评审的review,可以通过下面的命令将代码评审下载到本地:

$ git clone git@codeup.aliyun.com:codeup/codeup.git
    $ cd codeup
    $ git download 888

评审下载成功后,HEAD会自动切换到代码评审的最新提交版本(作为detached引用),如果希望在一个分支下工作,可以执行

$ git checkout -b topic1

review可以正常工作,提交代码后执行以下命令对第 888 号代码评审进行更新:

$ git pr --change 888

4. 命令行创建和更新代码评审的授权

git-repo针对集中式评审设计了新的授权模型

  • 对于创建评审操作,用户只要拥有仓库的读取权限,就能向仓库发起代码评审,实现了仓库的人人可写。

  • 对于更新评审操作,用户需要为评审的author或reviewer,方可对评审进行更新。

5. 第三方应用覆盖了别名命令

OpenStack 社区的代码评审工具名为 git-review,如果系统中安装了 OpenStack 社区的 git-review 工具,则 git-repo 注册的别名命令 git-review 在运行时被覆盖。

执行 git repo 命令,如果发现存在别名命令被覆盖的情况,会显示警告信息。

$ git repo
    WARNING: you cannot use the git-repo alias command 'git-review', it is overrided by '/usr/local/bin/git-review' installed
    ... ...

遇到这种情况,请使用其它未占用的别名命令,如:git pr