代码审查机器人

由 ChatGPT 提供支持的代码审查机器人

翻译版本：英文 | 简体中文 | 繁體中文 | 韩语 | 日语

机器人使用说明

❗️⚠️ 由于成本考虑，BOT 目前仅用于测试目的，并且部署在 AWS Lambda 上，带有速率限制。因此，出现不稳定的情况是完全正常的。建议您自行部署应用。

安装

安装：apps/cr-gpt;

配置

1. 前往您想要集成此机器人的仓库主页
2. 点击 settings
3. 在 secrets and variables 下点击 actions
4. 切换到 Variables 选项卡，创建一个名为 OPENAI_API_KEY 的新变量，其值为您的 OpenAI API 密钥（对于 GitHub Actions 集成，请将其设置在 secrets 中）

开始使用

1. 当您创建一个新的 Pull Request 时，机器人会自动进行代码审查，审查信息将显示在 PR 时间线或文件更改部分。
2. 在 git push 更新 Pull Request 后，cr 机器人会重新审查已更改的文件。

示例：

ChatGPT-CodeReview/pull/21

使用 GitHub Actions

actions/chatgpt-codereviewer

1. 将 OPENAI_API_KEY 添加到您的 GitHub Actions 秘密中
2. 创建 .github/workflows/cr.yml 文件，并添加以下内容：

name: Code Review

permissions:
  contents: read
  pull-requests: write
  models: true # 如果选择使用 GitHub 模型，请将其设置为 true

on:
  pull_request:
    types: [opened, reopened, synchronize]

jobs:
  test:
    # if: ${{ contains(github.event.*.labels.*.name, 'gpt review') }} # 可选；仅在附加标签时运行
    runs-on: ubuntu-latest
    steps:
      - uses: anc95/ChatGPT-CodeReview@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

          # 如果使用 GitHub 模型 https://github.com/marketplace/models
          USE_GITHUB_MODELS: true
          MODEL: openai/gpt-4o

          # 如果使用 Azure 部署
          AZURE_API_VERSION: xx
          AZURE_DEPLOYMENT: xx

          # 否则使用标准 LLM 模型
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_ENDPOINT: https://api.openai.com/v1
          MODEL: gpt-3.5-turbo # https://platform.openai.com/docs/models

          # 共性
          LANGUAGE: Chinese
          PROMPT: # 示例：请检查以下代码差异中是否存在任何混淆或不规范之处：
          top_p: 1 # https://platform.openai.com/docs/api-reference/chat/create#chat/create-top_p
          temperature: 1 # https://platform.openai.com/docs/api-reference/chat/create#chat/create-temperature
          max_tokens: 10000
          MAX_PATCH_LENGTH: 10000 # 如果补丁/差异长度大于 MAX_PATCH_LENGTH，则会被忽略，不会进行审查。默认情况下，如果没有设置 MAX_PATCH_LENGTH，则对补丁/差异长度没有限制。
          IGNORE_PATTERNS: /node_modules/**/*,*.md # 忽略文件的 glob 模式或正则表达式模式，用逗号分隔
          INCLUDE_PATTERNS: *.js,*.ts # 包含文件的 glob 模式或正则表达式模式，用逗号分隔

自托管

1. 克隆代码
2. 将 .env.example 复制到 .env，并填写环境变量
3. 安装依赖并运行

npm i
npm i -g pm2
npm run build
pm2 start pm2.config.cjs

有关更多详细信息，请参阅 probot。

开发

设置

# 安装依赖
npm install

# 构建代码
npm run build

# 运行机器人
npm run start

Docker

# 1. 构建容器
docker build -t cr-bot .

# 2. 启动容器
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> cr-bot

贡献

如果您对如何改进 cr 机器人有任何建议，或者想报告 bug，请提交一个问题！我们欢迎所有贡献。

更多信息，请查看 贡献指南。

致谢

该项目受 codereview.gpt 的启发。

许可证

ISC © 2023 anc95

ChatGPT-CodeReview 快速上手指南

ChatGPT-CodeReview 是一个基于 ChatGPT 的自动化代码审查机器人，可集成到 GitHub Pull Request 流程中，自动提供代码改进建议。

环境准备

• 系统要求：支持 Node.js 的操作系统（Linux/macOS/Windows），或具备 Docker 环境。
• 前置依赖：
  • Node.js (推荐 v16+) 和 npm
  • GitHub 账号及仓库权限
  • OpenAI API Key（或 Azure OpenAI 配置）
• 网络提示：由于需要调用 OpenAI 接口，请确保运行环境能够访问 api.openai.com。如在国内开发环境部署，建议配置代理或使用支持国内访问的 LLM 服务端点。

安装步骤

本项目提供三种主要使用方式，请根据需求选择其一：

方式一：直接安装 GitHub App（最简单，无需部署）

适合快速测试或个人小项目。

1. 访问 cr-gpt App 安装页面。
2. 点击 Install 并授权目标仓库。
3. 配置密钥：
   • 进入目标仓库首页 -> 点击 Settings。
   • 在左侧菜单找到 Secrets and variables -> 点击 Actions。
   • 切换到 Variables 标签页，新建变量：
     • Name: OPENAI_API_KEY
     • Value: 你的 OpenAI API Key
   • (注：如果是为了 GitHub Action 集成，请在 Secrets 中设置)

方式二：通过 GitHub Actions 集成（推荐，可控性强）

适合需要自定义模型参数、语言或过滤规则的生产环境。

1. 设置密钥： 在仓库的 Settings -> Secrets and variables -> Actions -> Secrets 中，添加名为 OPENAI_API_KEY 的密钥。

2. 创建工作流文件： 在仓库根目录创建 .github/workflows/cr.yml，填入以下内容：

name: Code Review

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
    types: [opened, reopened, synchronize]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: anc95/ChatGPT-CodeReview@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          
          # 常用配置项
          LANGUAGE: Chinese              # 输出语言
          MODEL: gpt-3.5-turbo           # 模型名称
          temperature: 1                 # 创造性参数
          max_tokens: 10000              # 最大回复长度
          IGNORE_PATTERNS: /node_modules/**/*,*.md # 忽略的文件模式

方式三：自托管部署 (Self-hosting)

适合需要完全私有化部署或深度定制的场景。

1. 克隆代码：

   git clone https://github.com/anc95/ChatGPT-CodeReview.git
   cd ChatGPT-CodeReview
   

2. 配置环境变量：

   cp .env.example .env
   # 编辑 .env 文件，填入 APP_ID, PRIVATE_KEY, OPENAI_API_KEY 等信息
   

3. 安装依赖并运行：

   npm i
   npm i -g pm2
   npm run build
   pm2 start pm2.config.cjs
   

   (可选) 使用 Docker 部署：

   docker build -t cr-bot .
   docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> -e OPENAI_API_KEY=<your-key> cr-bot
   

基本使用

完成上述任一安装配置后，即可开始使用：

1. 触发审查： 在配置的仓库中创建一个新的 Pull Request (PR)，或者向现有的 PR 推送新的代码 (git push)。

2. 查看结果： 机器人会自动检测变更文件，并在 PR 的时间线（Timeline）或文件变更详情中发表评论，指出潜在的代码问题、规范冲突或优化建议。

3. 交互示例：

   • 当 PR 包含不规范的代码时，Bot 会直接在对应代码行附近留言。
   • 修改代码再次提交后，Bot 会对新增的 Diff 部分进行重新审查。

注意：官方提供的公共 Bot 实例出于成本考虑设有速率限制（Rate Limit），可能不稳定。生产环境强烈建议使用 方式二 或 方式三 自行部署。