|
| 1 | +import { defineConfig, type CodeRabbitContext } from "@coderabbitai/config"; |
| 2 | + |
| 3 | +const approvability = `Fail when a maintainer should read this pull request before CodeRabbit approves it, and name the rule and file. Fail if it: |
| 4 | +
|
| 5 | +- Changes a product default: a setting's default value, or what users get without opting in. Making a feature do what it already promises is a bug fix, not a default change. |
| 6 | +- Adds or broadens a directive that disables or suppresses a lint, type-checker, LSP, or other static-analysis diagnostic, including file-level, line-level, and configuration-level overrides. |
| 7 | +- Adds a subsystem or user workflow, or is a large refactor across apps or packages. |
| 8 | +- Changes packages/contracts or persisted data in a way that existing clients or stored data might not accept. |
| 9 | +- Changes authentication, pairing, credentials, secrets, or remote connection trust. |
| 10 | +- Adds or changes an external side effect, such as acting on GitHub, publishing a release, or calling a webhook. |
| 11 | +- Adds, upgrades, or patches a dependency. |
| 12 | +- Changes CI or release configuration, agent or contributor instructions, or any review tool's configuration, including .github/, AGENTS.md, CONTRIBUTING.md, .agents/, and .coderabbit.config.ts. |
| 13 | +
|
| 14 | +Otherwise pass. A focused bug fix, copy or layout fix, revert, or docs-only or test-only change passes unless a rule above applies. If you cannot decide, fail rather than report inconclusive. When failing, say that the pull request needs a maintainer's review. |
| 15 | +`; |
| 16 | + |
| 17 | +// Org members and collaborators merge their own pull requests. On anyone else's, CodeRabbit |
| 18 | +// requests changes until its comments are resolved and its checks pass, then approves. |
| 19 | +const UNGATED_AUTHORS = new Set(["OWNER", "MEMBER", "COLLABORATOR"]); |
| 20 | +const isGated = ({ pr }: CodeRabbitContext) => !UNGATED_AUTHORS.has(pr?.authorAssociation ?? ""); |
| 21 | + |
| 22 | +export default defineConfig((ctx) => ({ |
| 23 | + reviews: { |
| 24 | + high_level_summary: false, |
| 25 | + review_status: false, |
| 26 | + request_changes_workflow: isGated(ctx), |
| 27 | + allow_author_approval: !isGated(ctx), |
| 28 | + auto_review: { |
| 29 | + enabled: true, |
| 30 | + }, |
| 31 | + pre_merge_checks: { |
| 32 | + docstrings: { mode: "off" }, |
| 33 | + override_requested_reviewers_only: isGated(ctx), |
| 34 | + custom_checks: [ |
| 35 | + { |
| 36 | + name: "Approvability", |
| 37 | + mode: isGated(ctx) ? "error" : "off", |
| 38 | + instructions: approvability, |
| 39 | + }, |
| 40 | + ], |
| 41 | + }, |
| 42 | + path_filters: [ |
| 43 | + // Vendored read-only reference checkouts of upstream Effect and Alchemy |
| 44 | + // (see scripts/lib/reference-repos.ts). Nothing imports from them. |
| 45 | + "!.repos/**", |
| 46 | + ], |
| 47 | + path_instructions: [ |
| 48 | + { |
| 49 | + path: "{apps,packages,infra}/**/*.ts", |
| 50 | + instructions: "Hold changed code to the rules in docs/internals/effect-services.md.", |
| 51 | + }, |
| 52 | + { |
| 53 | + path: "apps/web/src/**/*.{tsx,css}", |
| 54 | + instructions: "Hold changed code to the rules in docs/internals/web-ui.md.", |
| 55 | + }, |
| 56 | + ], |
| 57 | + }, |
| 58 | + knowledge_base: { |
| 59 | + code_guidelines: { |
| 60 | + filePatterns: [ |
| 61 | + { files: "docs/internals/effect-services.md", applyTo: "{apps,packages,infra}/**/*.ts" }, |
| 62 | + { files: "docs/internals/web-ui.md", applyTo: "apps/web/src/**/*.{tsx,css}" }, |
| 63 | + ], |
| 64 | + }, |
| 65 | + }, |
| 66 | +})); |
0 commit comments