Repolode
anc95

anc95/ChatGPT-CodeReview

基于 ChatGPT 大模型、可自动为 Pull Request 代码差异添加审查评论的 GitHub 代码审查机器人。

Star
4,467
Fork
469
未关闭 Issue
60
最近提交
3个月前

这是什么?

ChatGPT-CodeReview 是一个代码审查机器人,它把 Pull Request 的代码差异发送给兼容 OpenAI 接口的大语言模型,并将反馈以审查评论的形式发布到 PR 中。项目支持作为 GitHub App 安装,也可以在工作流中作为 GitHub Action 使用,或以 Probot 应用的方式自行部署。

新建 Pull Request 时,机器人会审查变更文件并在 PR 时间线或文件变更页面给出评论;推送新提交后,它会重新审查更新的文件。配置项包括模型、输出语言、自定义提示词、temperature、token 上限,以及用于筛选文件的 include 和 ignore 通配规则。Action 方式还支持 Azure OpenAI 部署和 GitHub Models。

官方托管的机器人仅用于测试,存在速率限制,项目建议使用自己的 OpenAI API Key 自行部署。

核心功能

  • 01使用兼容 ChatGPT 的模型审查 Pull Request 代码差异,并在 PR 中发布评论。
  • 02推送新提交后自动重新审查更新过的文件。
  • 03可作为 GitHub Action 运行,也可通过 Probot 自行部署,并提供 Docker 构建方式。
  • 04支持自定义提示词、输出语言和模型参数。
  • 05通过 include、ignore 通配规则和最大 patch 长度筛选需要审查的文件。

适用场景

  • 为团队仓库的 Pull Request 增加自动化的首轮代码审查。
  • 通过 GitHub Actions 工作流在 CI 中运行基于大模型的代码审查。
  • 使用自己的 API Key 在私有基础设施上部署代码审查机器人。

快速上手

  1. 1

    从 README 中的链接安装托管的 GitHub App

  2. 2

    在仓库中添加 OPENAI_API_KEY 变量或密钥

  3. 3

    在 .github/workflows/cr.yml 中添加 GitHub Actions 工作流文件

使用前须知

  • 托管机器人仅用于测试,有速率限制,可能不稳定。
  • 运行代码审查需要您自己的 OpenAI 兼容 API 密钥或模型访问权限。
  • 自托管需要克隆代码、配置 .env 文件并运行构建和进程管理工具。

收录于专题

标签

常见问题

ChatGPT-CodeReview 是什么?
基于 ChatGPT 大模型、可自动为 Pull Request 代码差异添加审查评论的 GitHub 代码审查机器人。 ChatGPT-CodeReview 是一个代码审查机器人,它把 Pull Request 的代码差异发送给兼容 OpenAI 接口的大语言模型,并将反馈以审查评论的形式发布到 PR 中。项目支持作为 GitHub App 安装,也可以在工作流中作为 GitHub Action 使用,或以 Probot 应用的方式自行部署。
ChatGPT-CodeReview 可以免费使用吗?用的什么许可证?
ChatGPT-CodeReview 以 ISC 许可证开源。用于商业产品前,请先确认许可证条款。
ChatGPT-CodeReview 还在维护吗?
半年内有更新。ChatGPT-CodeReview 最近一次提交是在 2026年8月10日。
ChatGPT-CodeReview 适合用来做什么?
为团队仓库的 Pull Request 增加自动化的首轮代码审查。 通过 GitHub Actions 工作流在 CI 中运行基于大模型的代码审查。 使用自己的 API Key 在私有基础设施上部署代码审查机器人。
ChatGPT-CodeReview 怎么安装和运行?
从 README 中的链接安装托管的 GitHub App 在仓库中添加 OPENAI_API_KEY 变量或密钥 在 .github/workflows/cr.yml 中添加 GitHub Actions 工作流文件
在哪里获取 ChatGPT-CodeReview?
源代码和安装说明在 GitHub 上:https://github.com/anc95/ChatGPT-CodeReview

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目