AI代码审查器：基于OpenAI GPT-4的智能代码评审助手

AI代码审查器：基于OpenAI GPT-4的智能代码评审助手

项目地址:https://gitcode.com/gh_mirrors/ai/ai-codereviewer

本教程将指导您了解并使用

AI Code Reviewer

，一个利用OpenAI的GPT-4 API来提供pull请求的智能反馈和建议的GitHub Action。通过自动化代码审查过程，它旨在提升代码质量并节省开发者时间。

1. 项目目录结构及介绍

AI Code Reviewer项目遵循标准的GitHub Action项目布局，其主要目录和文件结构如下：

• .github/workflows: 这是放置GitHub Actions工作流文件的地方，其中至少应有一个用于触发AI Code Reviewer的工作流文件（如main.yml）。
• src: 包含实现核心功能的源代码文件。
• package.json: 定义了项目的npm依赖项以及scripts命令，用于构建和打包项目。
• LICENSE: 许可证文件，说明该项目遵循MIT协议。
• README.md: 项目的主要文档，包含了如何安装、配置及使用该工具的详细信息。

2. 项目的启动文件介绍

启动AI Code Reviewer并不需要直接手动执行任何“启动文件”，因为它是作为一个GitHub Action被调用的。关键在于创建或编辑

.github/workflows/main.yml

文件来配置这个Action。这一工作流文件定义了何时（例如，在新的pull request打开或同步时）以及如何运行AI Code Reviewer。

示例配置片段展示如下：

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" # 可选，排除不参与评审的文件类型

在实际应用中，你需要替换

your-username

为你自己的用户名，并确保已经设置相应的GitHub Secrets。

3. 项目的配置文件介绍

AI Code Reviewer的运行配置主要通过

.github/workflows/main.yml

中的步骤参数进行设定。此外，如果涉及到本地开发或自定义行为，可能还需要关注

package.json

中的脚本指令，特别是构建和测试相关的部分。

主要配置点：

• GITHUB_TOKEN: 自动化操作所需的GitHub Token，系统默认已提供。
• OPENAI_API_KEY: OpenAI API的密钥，需作为GitHub Secret存储。
• OPENAI_API_MODEL: 默认为gpt-4，可以指定不同的API模型。
• exclude: 指定不想让AI评审的文件模式列表，用逗号分隔。

通过以上步骤，您可以成功集成AI Code Reviewer到您的GitHub仓库，享受自动化的代码审查带来的便利。记得按照官方文档的要求正确设置GitHub Secrets，并且调整排除规则以适应您的项目需求。

ai-codereviewer AI Code Reviewer: Enhance your GitHub workflow with AI-powered code review! Get intelligent feedback and suggestions on pull requests using OpenAI's GPT-4 API, improving code quality and saving developers time. 项目地址: https://gitcode.com/gh_mirrors/ai/ai-codereviewer