AI代码审查员
AI代码审查员是一个GitHub Action,利用OpenAI的GPT-4 API提供智能反馈和建议,帮助改进代码质量并通过自动化代码审查流程节省开发人员的时间。
特性
- 使用OpenAI的GPT-4 API审查拉取请求。
- 提供智能评论和建议以改进您的代码。
- 过滤匹配指定排除模式的文件。
- 易于设置并集成到您的GitHub工作流程中。
设置
-
要使用这个GitHub Action,你需要一个OpenAI API密钥。如果你还没有,请在OpenAI注册获取API密钥。
-
将OpenAI API密钥作为GitHub Secret添加到您的代码库中,名称为
OPENAI_API_KEY
。关于GitHub Secrets的更多信息,请参见这里。 -
在你的代码库中创建一个
.github/workflows/main.yml
文件,并添加以下内容:
name: AI代码审查员
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代码审查员
uses: your-username/ai-code-reviewer@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GITHUB_TOKEN是默认存在的,所以你只需要保持原样,不需要特别添加它为一个密钥,否则会抛出错误。[更多信息](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" # 可选:使用逗号分隔的排除模式
-
将
your-username
替换为你的GitHub用户名或AI代码审查员代码库所在的组织名称。 -
如果你想忽略某些文件模式不被审查,可以自定义
exclude
输入。 -
提交更改到你的代码库,AI代码审查员将开始在你未来的拉取请求中工作。
操作原理
AI代码审查员GitHub Action获取拉取请求差异,过滤掉排除的文件,并将代码块发送到OpenAI API。然后根据AI的响应生成审查评论,并将其添加到拉取请求中。
贡献
欢迎贡献!请随时提交issue或拉取请求以改进AI代码审查员GitHub Action。
让维护者生成最终包(yarn build
& yarn package
)。
许可证
此项目根据MIT许可证授权。有关更多信息,请参阅LICENSE文件。