安装部署

Reviewbot 提供以下两种方式访问GitHub:

• Github APP 方式 (推荐)
• Access Token 方式

推荐使用Github APP的方式,因为Access Token 方式不支持GitHub CheckRun 姿势

提示

Github CheckRun 姿势看起来相对优雅一些, 一家之言。

创建一个GitHub APP也非常方便，参见:

• 基于实际情况，选择是在 Org 下创建，还是在 个人账号下创建.

  • Org: https://github.com/organizations/<your org>>/settings/apps
  • 个人: https://github.com/settings/apps

• 设置合适的 APP的权限

  • Repository permissions
    • Checks: Read & write
    • Commit statuses: Read & write
    • Pull requests: Read & write

• 订阅需要的事件

  • Pull Request
  • Pull Request Review
  • Pull Request Review Comment
  • Pull Request Review Thread
  • Push
  • Release
  • Commit Comment

当创建完APP之后，我们就可以获得 APP ID 和 APP Private Key, 这些信息在部署时需要。

当然仍然可以是用Access Token方式，只不过反馈会以Comment形式存在。

创建Access Token请参考GitHub官方文档.

部署

推荐通过Docker方式，部署到kubernetes集群

• 镜像构建，请参考 Dockerfile
• Kubernetes 部署: Reviewbot.yaml

待服务部署好之后，配置上合适的域名，然后将相关域名配置到GitHub Hook区域即可。

之后即可观察，服务是否能接受到GitHub事件，并正常执行。