ChatGPT-CodeReview

环境要求

• 一个 OpenAI API Key（用于 OPENAI_API_KEY）
• 可安装 GitHub App 或使用 GitHub Actions 的 GitHub 仓库
• 本地部署需 Node.js 与 npm 环境（README 使用 npm install / npm run start）
• 具备仓库 Settings 与 Secrets/Variables 的修改权限

安装与启动步骤

1. 1安装官方机器人

   打开 apps/cr-gpt 页面，按提示把 GitHub App 安装到你要审查的仓库上，授权后即可在 PR 中触发审查。

2. 2配置仓库变量

   进入目标仓库主页，点 Settings，在 Secrets and variables 下点 Actions，切到 Variables 标签，新建 OPENAI_API_KEY。

3. 3改用 GitHub Actions

   也可用 marketplace 上的 actions/chatgpt-codereviewer：把 OPENAI_API_KEY 加到 Actions secrets，再创建 .github/workflows/cr.yml。

4. 4克隆项目代码

   本地自行部署时，先把仓库克隆到本地，进入项目目录后再执行后续安装与启动命令。

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

   复制

5. 5安装依赖

   在项目根目录执行 npm install，安装 Probot 等运行所需依赖，网络较慢时可换国内镜像源。

   npm install

   复制

6. 6启动机器人

   依赖装好后执行 npm run start 启动服务，README 的本地 Setup 流程到此为止。

   npm run start

   复制

关键配置

如何确认成功

新建或 push 更新一个 Pull Request，在 PR 时间线或文件变更处看到机器人自动生成的审查评论即成功。

常见问题

注意事项

• 官方托管的 BOT 明确标注仅供测试、有限流，生产使用建议自行部署。
• README 的 Docker 章节内容不完整（仅有标题和代码块开头），不要照此猜测命令，请以仓库实际文件为准。
• README 的本地 Setup 只给出 npm install 与 npm run start，未列出所需的其他环境变量，实际运行前请对照仓库配置文件补充。
• 配置 API Key 时注意区分 Variables（App 方式）与 Secrets（GitHub Actions 方式）。