AutoReviewer

？由 ChatGPT 提供支持的自动代码审查？

GitHub 操作使用 OpenAI 的 GPT-4 来执行自动代码审查。当您创建 PR 时，我们的操作将自动审核代码并提出更改建议，就像人工代码审核员一样。

如何使用

• 从 OpenAI 获取 API 密钥
• 将其添加为 GitHub 机密
• 设置对每个 PR 运行的操作

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
jobs :
  code-review :
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

• 或者当添加标签时

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
    types : [labeled]
jobs :
  code-review :
    if : ${{ contains( github.event.label.name, 'AutoReview') }}
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

输入参数

范围	必需的	默认	描述
github_token	真的		与 GitHub 通信所必需的。由 GHA 自动生成
openai_api_key	真的		OpenAI API 密钥
型号名称	错误的	GPT-3.5-涡轮	OpenAI 聊天模型。目前支持gpt-4和gpt-3.5-turbo
模型温度	错误的	0	OpenAI模型温度
排除文件	错误的		提供通配符表达式以从代码审查中排除文件。例如， *.md将排除所有 Markdown 文件。通过逗号支持多个表达式，例如*.js, *.cjs

？好处

使用我们的 GitHub 操作有很多好处，例如：

• 更快的代码审查
• 更一致的反馈
• 提高生产力
• 提高代码质量

？局限性

• 此 GitHub Action 仍处于早期开发阶段。
• 虽然该操作同时支持gpt-4和gpt-3.5-turbo ， gpt-4提供了更好的建议。

？贡献

如果您对我们的 GitHub 操作有任何想法或改进，请随时提交 PR。我们欢迎所有贡献！