diff --git a/.github/coderabbit-config/README.md b/.github/coderabbit-config/README.md index 96cc07d4..877942e4 100644 --- a/.github/coderabbit-config/README.md +++ b/.github/coderabbit-config/README.md @@ -28,7 +28,7 @@ a schema library calls "invalid": | Class | Severity | Because | |---|---|---| | YAML parse error | error | CodeRabbit cannot read the file at all. | -| `maxLength` violation | error | File-rejecting. The schema carries **15** per-field caps, 50 → 20,000 chars. | +| `maxLength` violation | error | File-rejecting. The schema carries **17** per-field caps, 50 → 20,000 chars. | | type / enum error | error | File-rejecting. | | unknown / additional property | **warning** | CodeRabbit *strips* an unrecognized key rather than rejecting the file. Reported wherever the schema object accepts only the names it lists — see below. | | config path that is not a regular file, or > 512 KiB | exit 2 | "I could not check" must never look like a pass. A path resolving outside the repo root (symlinks resolved) is refused the same way. | @@ -96,7 +96,7 @@ carried exactly that shape when this landed. ## Why file size is the wrong invariant The obvious cheap check — "fail if `.coderabbit.yaml` gets too big" — would gate -nothing. There is no whole-document size cap in the schema, only the 15 per-field +nothing. There is no whole-document size cap in the schema, only the 17 per-field ones, and size is uncorrelated with validity: the invalid config that started this was 2,198 bytes while a valid one next to it was 4,826. Across the org sweep there were **zero** `maxLength` violations and three misplaced-key repos, so a size check diff --git a/.github/coderabbit-config/schema.v2.json b/.github/coderabbit-config/schema.v2.json index 6a1c997a..abba443b 100644 --- a/.github/coderabbit-config/schema.v2.json +++ b/.github/coderabbit-config/schema.v2.json @@ -252,6 +252,11 @@ "description": "Automatic approvals | Request changes for blocking findings. Automatically approve when required threads are resolved, the latest commit is reviewed, pre-merge checks pass, and configured risk limits are satisfied. In GitLab, required discussions must be resolved.", "type": "boolean" }, + "approve_on_skipped_review": { + "default": false, + "description": "Approve skipped reviews | When automatic approvals are enabled, allow approval when the entire review is intentionally skipped, such as for a draft pull request or a file limit. Errors and cancelled reviews are excluded. Existing findings, pre-merge checks and configured risk limits still apply.", + "type": "boolean" + }, "max_merge_risk": { "description": "Maximum merge risk for approval | Highest inclusive merge risk that permits approval. Omitted limits can be inherited; merge risk is unrestricted only when no configuration source sets a limit. A configured limit requires an assessment covering the current commit.", "type": "string", @@ -289,7 +294,7 @@ } }, "paths": { - "description": "Paths | Apply this override when any changed file matches these repository-relative globs. Uses the same glob syntax as path_filters, including ! exclusions. Renames match both old and new paths. When teams and paths are set, both must match. Omit to match all paths.", + "description": "Paths | Apply this override when any changed file matches these repository-relative globs. Uses the same glob syntax as `path_filters`, including ! exclusions. Renames match both old and new paths. When teams and paths are set, both must match. Omit to match all paths.", "minItems": 1, "type": "array", "items": { @@ -314,6 +319,16 @@ }, "additionalProperties": false }, + "merge_risk_instructions": { + "description": "Merge Risk Instructions | Describe what makes a pull request more or less risky to merge in this codebase. CodeRabbit uses this when rating merge risk, which `auto_approvals.max_merge_risk` can limit for automatic approval. Up to 3000 characters. Example: `Database migrations and billing changes are high risk. Docs-only and test-only changes are low risk.`", + "type": "string", + "maxLength": 3000 + }, + "security_risk_instructions": { + "description": "Security Risk Instructions | Describe facts about your system that affect security risk, such as which services are internet-facing, where tenant isolation is enforced, or which controls protect a path. CodeRabbit uses this when rating security architecture risk, which `auto_approvals.max_security_risk` can limit for automatic approval. Security risk assessments require the Advanced plan or above. Unlike Security scan context, which guides security findings in reviews and scans, this only affects the risk rating. Up to 3000 characters. Example: `The admin service is reachable only over the corporate VPN. Changes to tenant isolation in packages/tenancy are high risk.`", + "type": "string", + "maxLength": 3000 + }, "request_changes_workflow": { "description": "Legacy alias for reviews.auto_approvals.enabled.", "deprecated": true, @@ -373,17 +388,17 @@ }, "review_progress": { "default": true, - "description": "Publish the canonical user-facing review status and progress updates (GitHub progress reports/check runs today; other platform equivalents may follow).", + "description": "On GitHub with CodeRabbit Cloud, report each review as a check run named `CodeRabbit` that shows the review's progress and outcome. When disabled, CodeRabbit posts the `CodeRabbit` commit status instead, if `commit_status` is enabled. GitLab, Azure DevOps, Bitbucket, and self-hosted CodeRabbit use the commit status.", "type": "boolean" }, "commit_status": { "default": true, - "description": "Mirror review progress using legacy commit statuses for compatibility with required checks and existing automations. This setting is only used when review_progress is disabled.", + "description": "Post a commit status named `CodeRabbit` on the pull request's latest commit. It is pending while CodeRabbit reviews and turns successful when the review ends, including when it is skipped or rate limited. Used on GitLab, Azure DevOps, Bitbucket, and self-hosted CodeRabbit, and on GitHub when `review_progress` is disabled. Require it in branch protection to keep pull requests from merging while a review is in progress.", "type": "boolean" }, "fail_commit_status": { "default": false, - "description": "On review errors, fail the active outward review status surface. When review_progress is enabled this applies to progress reporting; otherwise it applies to the legacy commit-status mirror when enabled.", + "description": "Report a review that stops because of an error as failed, so a required `CodeRabbit` check blocks merging. When disabled, the GitHub check run ends as neutral and the commit status ends as successful, with the error in its description. Rate-limited reviews never fail.", "type": "boolean" }, "collapse_walkthrough": { @@ -529,7 +544,7 @@ }, "enable_prompt_for_ai_agents": { "default": true, - "description": "Prompt for AI Agents | Include the '🤖 Prompt for AI Agents' section in inline review comments to provide codegen instructions for AI agents.", + "description": "Prompt for Coding Agents | Include the '🤖 Prompt for Coding Agents' section in inline review comments to provide codegen instructions for AI agents.", "type": "boolean" }, "path_filters": { @@ -662,13 +677,15 @@ "type": "object", "properties": { "docstrings": { - "description": "Docstrings | Configure docstring generation.", + "description": "Docstrings | Deprecated. This setting has no effect: docstring generation has been retired.", + "deprecated": true, + "x-undocumented": true, "default": {}, "type": "object", "properties": { "enabled": { "default": true, - "description": "Docstrings | Enable the docstrings finishing touch (trigger via the 📝 Generate docstrings checkbox or `@coderabbitai generate docstrings`). CodeRabbit generates or improves docstrings for functions changed in the PR and opens a follow-up PR containing the docstring edits.", + "description": "Docstrings | Deprecated. This setting has no effect: docstring generation has been retired.", "type": "boolean" } } @@ -775,7 +792,9 @@ "type": "boolean" }, "docstrings": { - "description": "Docstring Coverage | Check that docstring coverage meets the configured threshold.", + "description": "Docstring Coverage | Deprecated. This setting has no effect: the Docstring Coverage pre-merge check has been retired.", + "deprecated": true, + "x-undocumented": true, "default": {}, "type": "object", "properties": { @@ -906,13 +925,13 @@ "type": "object", "properties": { "ast-grep": { - "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.45.3", + "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.51.1", "default": {}, "type": "object", "properties": { "enabled": { "default": true, - "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.45.3", + "description": "Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.51.1", "type": "boolean" }, "rule_dirs": { @@ -965,7 +984,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.16.10", + "description": "Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.17.4", "type": "boolean" }, "config_file": { @@ -981,7 +1000,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.23.3", + "description": "Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.24.0", "type": "boolean" } } @@ -1060,7 +1079,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v2.5.15", + "description": "Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v2.6.3", "type": "boolean" } } @@ -1100,7 +1119,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.3.0", + "description": "Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.3.3", "type": "boolean" }, "level": { @@ -1155,7 +1174,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v2.14.0", + "description": "Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v2.15.0", "type": "boolean" }, "config_file": { @@ -1195,7 +1214,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable TruffleHog | TruffleHog is a secret scanner with verification capabilities. | Enable TruffleHog integration. | v3.96.0", + "description": "Enable TruffleHog | TruffleHog is a secret scanner with verification capabilities. | Enable TruffleHog integration. | v3.99.8", "type": "boolean" } } @@ -1207,7 +1226,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Checkov | Checkov is a static code analysis tool for infrastructure-as-code files. | v3.3.25", + "description": "Enable Checkov | Checkov is a static code analysis tool for infrastructure-as-code files. | v3.3.30", "type": "boolean" } } @@ -1219,7 +1238,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable TFLint | TFLint is a Terraform linter for finding potential errors. | v0.64.0", + "description": "Enable TFLint | TFLint is a Terraform linter for finding potential errors. | v0.66.0", "type": "boolean" } } @@ -1304,7 +1323,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Fortitude | Fortitude is a Fortran linter that checks for code quality and style issues | v0.9.2", + "description": "Enable Fortitude | Fortitude is a Fortran linter that checks for code quality and style issues | v0.10.0", "type": "boolean" } } @@ -1316,7 +1335,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.91.0", + "description": "Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.92.1", "type": "boolean" } } @@ -1328,7 +1347,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Buf | Buf offers linting for Protobuf files. | v1.73.0", + "description": "Enable Buf | Buf offers linting for Protobuf files. | v1.74.0", "type": "boolean" } } @@ -1364,7 +1383,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable zizmor | zizmor is a static security analyzer for GitHub Actions workflow files. | v1.30.1", + "description": "Enable zizmor | zizmor is a static security analyzer for GitHub Actions workflow files. | v1.31.1", "type": "boolean" } } @@ -1376,7 +1395,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable PMD | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.28.0", + "description": "Enable PMD | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.29.0", "type": "boolean" }, "config_file": { @@ -1392,7 +1411,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Clang for C/C++ static analysis and code quality checks | v14.0.6", + "description": "Enable Clang for C/C++ static analysis and code quality checks | v23.1.4", "type": "boolean" } } @@ -1440,7 +1459,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable OpenGrep | OpenGrep is a high-performance static code analysis engine for finding security vulnerabilities and bugs across 17+ languages. | v1.30.1", + "description": "Enable OpenGrep | OpenGrep is a high-performance static code analysis engine for finding security vulnerabilities and bugs across 17+ languages. | v1.33.0", "type": "boolean" } } @@ -1452,7 +1471,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.179.0", + "description": "Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.183.0", "type": "boolean" }, "config_file": { @@ -1468,7 +1487,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v1.2.0", + "description": "Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v1.9.0", "type": "boolean" } } @@ -1508,7 +1527,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Squawk for Postgres migration linting | Detects unsafe schema changes that can cause downtime or blocking locks | v2.67.0", + "description": "Enable Squawk for Postgres migration linting | Detects unsafe schema changes that can cause downtime or blocking locks | v2.70.0", "type": "boolean" } } @@ -1520,7 +1539,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Trivy for security scanning of IaC files (Terraform, Kubernetes, Docker, etc.) | v0.75.0", + "description": "Enable Trivy for security scanning of IaC files (Terraform, Kubernetes, Docker, etc.) | v0.76.2", "type": "boolean" } } @@ -1544,7 +1563,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Pylint | Pylint is a Python static code analysis tool. | v4.1.2", + "description": "Enable Pylint | Pylint is a Python static code analysis tool. | v4.1.3", "type": "boolean" } } @@ -1556,7 +1575,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Oxlint | Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. | v1.87.0", + "description": "Enable Oxlint | Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. | v1.89.0", "type": "boolean" } } @@ -1568,7 +1587,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 4.8.5 | theme 3.58.2", + "description": "Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 5.0.0 | theme 3.58.2", "type": "boolean" } } @@ -1654,7 +1673,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable OSV Scanner | OSV Scanner is a tool for vulnerability package scanning | v2.6.0", + "description": "Enable OSV Scanner | OSV Scanner is a tool for vulnerability package scanning | v2.7.0", "type": "boolean" } } @@ -1666,7 +1685,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable oasdiff | oasdiff detects breaking changes between OpenAPI specifications. | v1.33.0", + "description": "Enable oasdiff | oasdiff detects breaking changes between OpenAPI specifications. | v1.34.0", "type": "boolean" } } @@ -1678,19 +1697,19 @@ "properties": { "enabled": { "default": true, - "description": "Enable React Doctor | React Doctor scans React codebases for security, performance, correctness, and accessibility issues. | v0.9.17", + "description": "Enable React Doctor | React Doctor scans React codebases for security, performance, correctness, and accessibility issues. | v0.9.18", "type": "boolean" } } }, "presidio": { - "description": "Microsoft Presidio Analyzer 2.2.364 detects sensitive identifiers (including payment cards, US SSN, cryptocurrency wallets, and phone numbers) in changed files. Tune entities, thresholds, and languages in repository Presidio configuration (for example .presidiocli or AnalyzerEngineProvider YAML); the built-in scan uses fixed defaults and is skipped when that configuration is present.", + "description": "Microsoft Presidio Analyzer 2.2.366 detects sensitive identifiers (including payment cards, US SSN, cryptocurrency wallets, and phone numbers) in changed files. Tune entities, thresholds, and languages in repository Presidio configuration (for example .presidiocli or AnalyzerEngineProvider YAML); the built-in scan uses fixed defaults and is skipped when that configuration is present.", "default": {}, "type": "object", "properties": { "enabled": { "default": true, - "description": "Enable Microsoft Presidio Analyzer for high-signal PII in changed files | v2.2.364", + "description": "Enable Microsoft Presidio Analyzer for high-signal PII in changed files | v2.2.366", "type": "boolean" } } @@ -1702,7 +1721,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable Blinter | Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems. | v1.1.31", + "description": "Enable Blinter | Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems. | v1.1.49", "type": "boolean" } } @@ -1726,7 +1745,7 @@ "properties": { "enabled": { "default": true, - "description": "Enable ember-template-lint | ember-template-lint is a linter for Handlebars template files that checks for common issues such as accessibility violations, deprecated patterns, and template anti-patterns. | v7.9.3", + "description": "Enable ember-template-lint | ember-template-lint is a linter for Handlebars template files that checks for common issues such as accessibility violations, deprecated patterns, and template anti-patterns. | v7.9.4", "type": "boolean" } } @@ -1850,7 +1869,7 @@ }, "filePatterns": { "default": [], - "description": "File Patterns | Patterns for your coding guideline documents. CodeRabbit scans these files to learn your standards and apply them during reviews. Multiple files supported; file names are case-sensitive. An entry may also reference another repository the CodeRabbit installation can read, as repo:path or owner/repo:path (e.g. engineering-standards:frontend/react.md, globs supported); such files are read at that repository's default branch. A bare repo name uses the reviewed repository's owner. On GitHub.com, owner/repo:path may reference another organization when the CodeRabbit App is installed there with access to the source repository. Every cross-organization source requires author and review-actor read access under the existing identity rules, even when named by trusted target configuration. Other providers require the same organization. Defaults include: (**/.cursorrules, .github/copilot-instructions.md, **/CLAUDE.md, **/.claude/rules/**/*.md, **/GEMINI.md, **/.cursor/rules/*, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md, **/AGENTS.md, **/REVIEW.md).", + "description": "File Patterns | Patterns for your coding guideline documents. CodeRabbit scans these files to learn your standards and apply them during reviews. Multiple files supported; file names are case-sensitive. An entry may also reference another repository the CodeRabbit installation can read, as repo:path or owner/repo:path (e.g. engineering-standards:frontend/react.md, globs supported); such files are read at that repository's default branch. A bare repo name uses the reviewed repository's owner. On GitHub.com, owner/repo:path may reference another organization when the CodeRabbit App is installed there with access to the source repository. Every cross-organization source requires author and review-actor read access under the existing identity rules, even when named by trusted target configuration. Other providers require the same organization. Defaults include: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/**/*.instructions.md, **/CLAUDE.md, **/.claude/rules/**/*.md, **/GEMINI.md, .gemini/styleguide.md, **/.cursor/rules/*, **/.cursor/BUGBOT.md, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md, **/AGENTS.md, **/REVIEW.md, **/.greptile/rules.md).", "type": "array", "items": { "anyOf": [ @@ -1995,7 +2014,7 @@ }, "automatic_repository_linking": { "default": false, - "description": "Automatic Repository Linking | Deprecated. This setting has no effect. Use knowledge_base.automatic_linking_mode instead.", + "description": "Automatic Repository Linking | Deprecated. This setting has no effect. Use `knowledge_base.automatic_linking_mode` instead.", "deprecated": true, "type": "boolean" }, @@ -2030,7 +2049,9 @@ "type": "object", "properties": { "docstrings": { - "description": "Docstring Generation | Settings for generating docstrings.", + "description": "Docstring Generation | Deprecated. This setting has no effect: docstring generation has been retired.", + "deprecated": true, + "x-undocumented": true, "default": { "path_instructions": [] }, @@ -2038,7 +2059,7 @@ "properties": { "language": { "default": "en-US", - "description": "Language for generated docstrings (ISO language code).", + "description": "Deprecated. This setting has no effect: docstring generation has been retired.", "type": "string", "enum": [ "de", @@ -2247,7 +2268,7 @@ }, "path_instructions": { "default": [], - "description": "Path Instructions | Add path-specific guidelines for docstring generation.", + "description": "Path Instructions | Deprecated. This setting has no effect: docstring generation has been retired.", "type": "array", "items": { "type": "object", @@ -2259,7 +2280,7 @@ "instructions": { "type": "string", "maxLength": 20000, - "description": "Additional docstring-generation guidelines for matching paths." + "description": "Deprecated. This setting has no effect: docstring generation has been retired." } }, "required": ["path", "instructions"] diff --git a/.github/coderabbit-config/tests/test_schema_drift.py b/.github/coderabbit-config/tests/test_schema_drift.py index b0ccf5c4..2c95b23b 100644 --- a/.github/coderabbit-config/tests/test_schema_drift.py +++ b/.github/coderabbit-config/tests/test_schema_drift.py @@ -214,8 +214,11 @@ def test_the_committed_schema_has_the_documented_cap_set(self): # arrived with #288's refresh and is pinned so the 15th cap is checked # rather than merely counted. self.assertEqual(caps["chat.integrations.jira.issue_template"], 3000) + # The 16th and 17th arrived together with #467's refresh. + self.assertEqual(caps["reviews.merge_risk_instructions"], 3000) + self.assertEqual(caps["reviews.security_risk_instructions"], 3000) # README.md documents this count and the 50 -> 20,000 span; both move together. - self.assertEqual(len(caps), 15) + self.assertEqual(len(caps), 17) self.assertEqual((min(caps.values()), max(caps.values())), (50, 20000))