CodeRabbit使用指南

CodeRabbit使用指南

CodeRabbit作为GitHub Action运行，可以自动为每个拉取请求（Pull Request）提供AI摘要和逐行代码审查，支持在GitHub评论线程中与AI进行上下文对话，实现协作式审查。

一、安装与配置

1. 确保GitHub仓库准备

   • 确保你的GitHub仓库已准备好接收GitHub Actions。

2. 获取OpenAI API密钥

   • 访问OpenAI官网，注册并获取API密钥，用于调用其服务。

3. 配置环境变量

   • 在你的GitHub仓库的Secrets里添加以下两项秘密：
     • GITHUB_TOKEN：用来添加评论到Pull Request，通常GitHub Action环境中已提供，但请确保已正确配置。
     • OPENAI_API_KEY：从OpenAI账户获得，用于API访问。

4. 添加GitHub Action配置文件

   • 在你的仓库中创建或编辑.github/workflows目录下的ai-pr-reviewer.yml文件，确保替换相应的环境变量配置以适应你的需求，比如开启调试模式（debug: true）以便于查看内部消息。

二、使用CodeRabbit进行代码审查

1. 自动审查

   • 一旦CodeRabbit集成到GitHub仓库中，它将自动为每个Pull Request提供AI摘要和逐行代码审查。

2. 查看审查结果

   • 在Pull Request页面，你可以看到CodeRabbit生成的变更摘要、发布说明以及逐行代码审查建议。

3. 与CodeRabbit对话

   • 支持在GitHub评论线程中与CodeRabbit进行上下文对话，提问或请求反馈。AI会根据提供的信息生成相应的回复和建议。

4. 自定义审查

   • 通过配置system_message值，用户可以改变机器人的“个性”和审查焦点。例如，要专注于文档或博客文章的审查，可以自定义相应的提示。

三、高级功能

1. 双模型策略

   • CodeRabbit使用“轻量级”模型（如GPT-3.5-turbo）进行摘要生成，使用“重量级”模型（如GPT-4）进行深度代码审查，以平衡成本和效果。

2. 智能审查跳过

   • 默认情况下，CodeRabbit对简单更改（如拼写修正）和看起来良好的变更跳过深度审查，但用户可以通过配置调整这一行为。

3. 持续增量审查

   • CodeRabbit针对Pull Request中的每次提交进行审查，而不是仅对整个Pull Request进行一次性审查，从而节省成本并减少冗余信息。

四、注意事项

1. 成本考虑

   • 使用GPT-4进行复杂的审查和评论任务时，成本较高。请根据实际使用情况合理配置模型选择。

2. 私有代码仓库

   • 在私有代码仓库中使用前，请与合规团队确认，并确保遵守相关数据使用政策。

3. 调试与配置

   • 通过在工作流文件中设置debug: true来启用调试模式，这将显示与OpenAI服务器之间的消息交互，有助于排查问题。

4. Fork仓库的审查

   • 由于GitHub Actions对来自Fork仓库的Pull Request的secrets访问有限制，要启用对Fork Pull Request的审查，需要使用pull_request_target事件替代pull_request事件，并进行额外配置。

通过以上步骤和注意事项，你可以轻松地在项目中集成并使用CodeRabbit进行高效的代码审查。CodeRabbit的智能化和自动化特性将显著提升你的代码质量和开发效率。