CodeRabbit AI 代码审查平台：GitHub/GitLab 集成指南与逐行分析技巧

? 一、GitHub 集成指南

1. 安装准备：确保你的 GitHub 仓库已准备好接收 GitHub Actions，并获取一个 OpenAI API 密钥，用于调用其服务。
2. 配置环境变量：在 GitHub 仓库的 Secrets 里添加两项秘密，分别是 GITHUB_TOKEN（用于向 Pull Request 添加评论）和 OPENAI_API_KEY（从 OpenAI 账户获得，用于 API 访问）。
3. 添加 GitHub Action 配置文件：在仓库中创建或编辑 .github/workflows 目录下的 ai-pr-reviewer.yml 文件，内容如下示例：

name: AI PR Reviewer
on:
  pull_request:
    types: [opened, synchronize, reopened]
  pull_request_review_comment:
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: coderabbitai/ai-pr-reviewer@v1.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
          openai_api_org: ${{ secrets.OPENAI_API_ORG || '' }}
          openai_light_model: gpt-3.5-turbo
          openai_heavy_model: gpt-
          debug: false

4. 模型选择与成本考量：推荐使用 gpt-3.5-turbo 进行轻量级任务（如 PR 摘要生成），使用 gpt-4 进行复杂的审查和评论任务。虽然 gpt-4 的成本较高，但其结果质量显著优于 gpt-3.5-turbo。根据实际使用情况，一个 20 人的开发团队使用 gpt-4 进行审查和评论，每天的成本约为 20 美元。

? 二、GitLab 集成指南

1. 访问 CodeRabbit 登录页面：选择 Self-Hosted GitLab。
2. 输入 GitLab 实例 URL：在页面中输入你的自托管 GitLab 实例的 URL，并点击提交。
3. 选择 Onboarding 方式：
   • 自动化 Onboarding：需要管理员访问令牌来在自托管实例中设置新的 CodeRabbit 机器人用户。
   • 手动 Onboarding：需要创建 CodeRabbit 用户和 OAuth2 GitLab 应用。创建用户时，建议使用专用用户名为 CodeRabbit AI，并生成访问令牌用于在合并请求上发布评论。创建 OAuth2 应用时，需设置回调 URL 为 https://app.coderabbit.ai/login。
   
   

? 三、逐行分析技巧

1. 上下文感知反馈：CodeRabbit 能够结合代码上下文和项目历史进行审查，例如在检测到未处理的异常或 SQL 注入风险时，会直接在 IDE 中标注问题代码，并给出修复建议。
2. 智能审查跳过：默认情况下，CodeRabbit 会跳过对简单更改（如拼写修正）和看起来良好的变更的深度审查。你可以通过配置 review_simple_changes 和 review_comment_lgtm 为 true 来禁用此功能。
3. 自定义提示：允许用户自定义 system_message、summarize 和 summarize_release_notes 提示，以聚焦特定审查方面或更改审查目标。例如，要专注于文档或博客文章的审查，可以使用以下提示：

你的目标是扮演一个经验丰富的 DevRel（开发者关系）专业人士，专注于云原生基础设施。在审查或生成内容时，请关注以下关键领域：
- 准确性
- 相关性
- 清晰度
- 技术深度
- 行动号召
- SEO 优化
- 品牌一致性
- 语法和文笔
- 拼写错误
- 超链接建议
- 图形或图像（如需要，建议 Dall-E 图像提示）
- 同理心
- 参与度

4. 交互式对话：支持与机器人进行上下文相关的对话，用于提供额外上下文、生成测试用例或简化代码复杂度。你可以在 PR 评论中回复机器人的评论，或通过在评论中标记 @coderabbitai 来邀请机器人参与对话。

? 四、实际效果与优势

1. 提高代码质量：通过逐行代码审查和深度分析，能够有效识别潜在的 bug、安全漏洞和代码异味，帮助开发者快速定位并修复问题。
2. 节省时间和成本：自动化审查减少了手动审查的时间和工作量，同时通过增量审查节省了 OpenAI API 成本并减少了冗余信息。
3. 增强团队协作：支持与机器人的交互式对话，促进了团队内的技术讨论和知识共享。
4. 支持多种编程语言：兼容 JavaScript、Python、Java、Go 等主流编程语言，适用于各种项目场景。

? 五、使用建议

1. 结合其他工具：CodeRabbit 可以与 Cursor、GitHub Copilot 等工具结合使用，形成更高效的开发流程。例如，先用 Cursor 快速编写代码，然后让 CodeRabbit 进行审核，最后再用 Cursor 辅助修复问题。
2. 关注代码隐私：CodeRabbit 非常重视安全，你的代码只用于分析，不会被永久存储，所有传输过程都加密。
3. 合理选择版本：免费版适用于个人开发者和小团队，每天有一定的审核次数。团队和专业用户可以选择付费版，享受更高额度和更多功能，如 PR/MR 审核、联动 Lint/SAST、项目管理工具等。