基于 ChatGPT Code Review 机器人

小安anc
4,262 阅读2分钟

机器人：github.com/apps/cr-gpt

源码仓库：ChatGPT-CodeReview

Code Review 是开发人员日常工作中不可或缺的一部分，它有助于确保代码质量，提高代码的可读性和可维护性。但是，人工评审是一项非常耗时且容易出错的工作，因此，代码评审机器人的出现是非常有意义的。

这就是我们今天要介绍的 Github CodeReview 机器人的由来。该机器人使用了 OpenAI 推出的大型语言模型 ChatGPT，它可以帮助开发人员快速高效地进行代码评审。

为什么使用 ChatGPT 进行代码评审？

使用 ChatGPT 进行代码评审有以下优势：

  1. 比人工评审更快：ChatGPT 可以在短时间内评审大量代码，因此，您不必为评审代码而浪费大量时间。
  2. 更精确：ChatGPT 是一个大型语言模型，它可以理解代码，并且不会因为疲劳、兴趣缺失或其他因素导致评审质量下降。
  3. 更全面：ChatGPT 可以评审代码的不同方面，例如代码的可读性、可维护性、安全性等。

如何使用 Github CodeReview 机器人？

安装机器人

github.com/apps/cr-gpt;

配置

  1. 注册 ChatGPT 并生成一个 APIKey
  2. 给需要集成 CodeReview 的仓库创建一个 Actions Variable，key 为 OPENAI_API_KEY, value 为第一步生成的 APIKey

image.png

3。 提交一个新的 PR，就会触发 机器人 Review. 继续给当前 PR push 新的 commit，机器人也会对新增的文件进行 review

image.png

Demo

以 Github Actions 的方式集成

推荐这种方式，因为机器人是部署在一个单机的 VPS 上，用户多的话，稳定性会比较差 actions/chatgpt-codereviewer

  1. 配置 OPENAI_API_KEY 到 github actions secrets
  2. 创建 .github/workflow/cr.yml 并添加如下内容
name: Code Review

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
    types: [opened, reopened]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: anc95/ChatGPT-CodeReview@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

私有化部署

参考 Self-hosting 文档进行部署

感谢您的阅读

感谢您的阅读！如果您觉得这个 Github CodeReview 机器人有用，请不要忘记给 源代码仓库点个赞，让更多人了解到这个优秀的工具！

本文正在参加 ✍🏻 技术视角深入 ChatGPT 征文活动

avatar
文章
阅读
粉丝