AI 代码审查工具

AI 代码审查工具是一个 GitHub Action，它利用 OpenAI 的 GPT-4 API 对您的拉取请求提供智能反馈和建议。这款强大的工具通过自动化代码审查流程，帮助提升代码质量并节省开发人员的时间。

功能特性

• 使用 OpenAI 的 GPT-4 API 审查拉取请求。
• 提供智能评论和改进建议，以优化您的代码。
• 过滤掉与指定排除模式匹配的文件。
• 易于设置，并可轻松集成到您的 GitHub 工作流中。

设置步骤

1. 要使用此 GitHub Action，您需要一个 OpenAI API 密钥。如果您还没有，请在 OpenAI 注册获取一个 API 密钥。

2. 将 OpenAI API 密钥添加为仓库中的 GitHub Secret，名称为 OPENAI_API_KEY。有关 GitHub Secret 的更多信息，请参阅 此处。

3. 在您的仓库中创建 .github/workflows/main.yml 文件，并添加以下内容：

name: AI Code Reviewer

on:
  pull_request:
    types:
      - opened
      - synchronize
permissions: write-all
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3

      - name: AI Code Reviewer
        uses: your-username/ai-code-reviewer@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GITHUB_TOKEN 默认已存在，因此无需将其作为 Secret 添加，否则会引发错误。[更多详情](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token_secret)
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4" # 可选：默认为 "gpt-4"
          exclude: "**/*.json, **/*.md" # 可选：用逗号分隔的排除模式

4. 将 your-username 替换为您或您的组织的 GitHub 用户名，即 AI 代码审查工具仓库所在的用户名或组织名。

5. 如果您希望忽略某些文件模式不参与审查，可以自定义 exclude 输入。

6. 将更改提交到您的仓库，AI 代码审查工具将开始处理您未来的拉取请求。

工作原理

AI 代码审查工具 GitHub Action 会获取拉取请求的差异，过滤掉被排除的文件，然后将代码片段发送至 OpenAI API。接着，它根据 AI 的响应生成审查评论，并将其添加到拉取请求中。

贡献

欢迎贡献！请随时提交问题或拉取请求，以改进 AI 代码审查工具 GitHub Action。

请让维护者生成最终的软件包（运行 yarn build 和 yarn package）。

许可证

本项目采用 MIT 许可证授权。更多信息请参阅 LICENSE 文件。

AI Code Reviewer 快速上手指南

AI Code Reviewer 是一款 GitHub Action 工具，利用 OpenAI GPT-4 API 自动审查 Pull Request，提供智能的代码改进建议，帮助提升代码质量并节省开发时间。

环境准备

• 平台要求：GitHub 仓库
• 前置依赖：
  • 有效的 OpenAI API Key（需具备 GPT-4 访问权限）
  • GitHub 账号及仓库写入权限

安装步骤

1. 获取 OpenAI API Key 访问 OpenAI 官网 注册并获取 API Key。

2. 配置 GitHub Secrets 在目标 GitHub 仓库中，进入 Settings > Secrets and variables > Actions，添加一个新的 Secret：

   • Name: OPENAI_API_KEY
   • Value: 你的 OpenAI API Key

3. 创建工作流文件 在仓库根目录创建 .github/workflows/main.yml 文件。

基本使用

将以下配置内容复制到 .github/workflows/main.yml 中，并将 your-username 替换为实际的 GitHub 用户名或组织名：

name: AI Code Reviewer

on:
  pull_request:
    types:
      - opened
      - synchronize
permissions: write-all
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v3

      - name: AI Code Reviewer
        uses: your-username/ai-code-reviewer@main
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4"
          exclude: "**/*.json, **/*.md"

配置说明：

• GITHUB_TOKEN：保持默认即可，无需额外配置。
• OPENAI_API_MODEL：可选，默认为 gpt-4。
• exclude：可选，用于排除不需要审查的文件模式（如 json、md 文件），多个模式用逗号分隔。

完成提交后，当有新的 Pull Request 打开或更新时，AI Code Reviewer 将自动运行并在 PR 中留下审查评论。