ai codereviewer

人工智能代码审查员

AI Code Reviewer 是一个 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 Secrets 的更多信息。

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 }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](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 " # Optional: defaults to "gpt-4"
          exclude : " **/*.json, **/*.md " # Optional: exclude patterns separated by commas

4. 将your-username替换为您的 GitHub 用户名或 AI Code Reviewer 存储库所在的组织名称。

5. 如果您想要忽略某些文件模式进行审查，请自定义exclude输入。

6. 将更改提交到您的存储库，AI Code Reviewer 将开始处理您未来的拉取请求。

它是如何运作的

AI Code Reviewer GitHub Action 检索拉取请求差异，过滤掉排除的文件，并将代码块发送到 OpenAI API。然后，它根据人工智能的响应生成审核评论，并将其添加到拉取请求中。

贡献

欢迎贡献！请随时提交问题或拉取请求以改进 AI Code Reviewer GitHub Action。

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

执照

该项目已获得 MIT 许可证的许可。有关详细信息，请参阅许可证文件。