用途
CodeRabbit 参考架构用于设计一套受治理的 CodeRabbit 部署方案,覆盖提供方、配置、评审、知识、工具、数据、身份与可观测性等维度。其核心目标是让权限与数据流变得明确,将来源、控制平面、提供方事件、知识来源与报告相互分离。
主要能力
- 映射组织、提供方、仓库、信任区、数据、身份、计划与门禁。
- 绘制配置解析与评审事件流,并标注归属关系。
- 选择知识、工具、缓存、保留、报告与连续性控制措施。
- 验证正常路径、排除路径、提供方故障路径、密钥路径与回滚路径。
- 输出边界图、权限矩阵、数据流、控制措施、失败模式与分阶段计划,并包含来源日期、未知项以及观察事实与建议之间的确切边界。
使用方式
前置条件包括:识别 CodeRabbit 组织、Git 提供方、仓库、计划与责任人;阅读 references/official-docs.md,并在执行前复核任何时效性契约;在审批边界满足前使用合成或只读证据;保留仓库独立的 CI、安全与人工评审要求。
工具纪律方面:使用 Glob 在不扩大范围的前提下定位候选配置与证据文件;使用 Grep 查找相关字段、命令、标识符与过时声明;使用 Read 检查最小必要文件与权威证据;仅在获得批准的新本地草稿或证据产物时使用 Write;仅在回滚已知的有界批准变更中使用 Edit。不得将这些文件工具作为经过认证的 CodeRabbit 或提供方操作的替代品。
审批边界方面:在扩大范围前需要架构、安全、隐私、仓库与平台负责人批准。在明确批准前,将分析与草稿保留在本地,并记录谁批准了该操作及其范围。
适用场景
- 设计带有本地例外与全局安全覆盖的中央默认配置。
- 仅在数据范围与认证获批后添加 MCP 上下文。
- 需要为 CodeRabbit 部署建立权限矩阵、数据流与失败模式文档的治理场景。
限制
- 当前契约不清晰或文档不一致时:停止变更,引用两个来源,并请求负责人解决。
- 缺少所需访问权限或批准时:仅生成草稿与证据计划。
- 验证或试点行为与预期不符时:恢复先前状态并保留失败证据。
- 输出包含密钥或私有代码时:停止、隔离产物、脱敏并通知数据所有者。
- 验证要求:对照 references/official-docs.md 中带日期的来源确认每项声明;核实请求范围、负责人、批准、正常路径、失败路径与回滚;在任何获批变更后重新读取有效配置或提供方状态;将不支持的字段、未记录的端点与未经验证的假设报告为失败。
- 官方文档与契约说明需在任何实时操作前重新复核带日期的契约;将未解决或已变更的供应商行为视为停止条件。
认证
将 Git 提供方会话、CodeRabbit Web 会话、CLI 凭据与 CodeRabbit API 密钥视为独立凭据。仅使用已批准的会话或密钥管理器引用,绝不打印密钥,也不得将凭据放入 .coderabbit.yaml、源文件、日志或交付物中。
当前契约
仓库 YAML、中央配置、设置与全局覆盖构成优先级。CodeRabbit 可使用指南、学习内容、关联仓库、MCP 与工具。提供方支持与认证方式各不相同。仪表板、导出、报告与 API 是相互独立的。