ai-codereviewer

AI Code Reviewer 项目介绍

AI Code Reviewer 是一款基于 GitHub Actions 的工具，它利用了 OpenAI 的 GPT-4 API 来对开发者的拉取请求提供智能化的反馈和建议。这款强大的工具旨在提升代码质量，同时通过自动化的代码审查过程为开发者节省时间。

项目特点

• 使用 OpenAI 的 GPT-4 API 来审查拉取请求。
• 提供智慧化的评论和建议，帮助改善代码。
• 能过滤掉符合指定排除模式的文件。
• 易于设置并集成到 GitHub 的工作流程中。

设置步骤

1. 要使用此 GitHub Action，用户需要一个 OpenAI API 密钥。如果用户没有，需要前往 OpenAI 注册一个 API 密钥。

2. 将 OpenAI API 密钥添加为 GitHub 仓库中的一个秘密，并命名为 OPENAI_API_KEY。

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 }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL: "gpt-4" # 可选项，默认值为 "gpt-4"
          exclude: "**/*.json, **/*.md" # 可选项：用于排除的文件模式，用逗号分隔

4. 将 your-username 替换为用户的 GitHub 用户名或组织名，在这里 AI Code Reviewer 仓库所在的位置。

5. 如果用户希望忽略某些文件模式的审查，可以自定义 exclude 输入。

6. 提交变更到仓库，AI Code Reviewer 就会开始在未来的拉取请求中工作。

工作原理

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

贡献

我们欢迎任何对 AI Code Reviewer 项目的贡献！用户可以提交问题或拉取请求以帮助改进此 GitHub Action。

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

许可证

本项目基于 MIT 许可证进行授权。有关更多信息，请参阅 LICENSE 文件。