Skip to content

Fix CodeRabbit configuration schema validation#6

Merged
DecisionNerd merged 1 commit into
mainfrom
fix/coderabbit-config
Feb 1, 2026
Merged

Fix CodeRabbit configuration schema validation#6
DecisionNerd merged 1 commit into
mainfrom
fix/coderabbit-config

Conversation

@DecisionNerd
Copy link
Copy Markdown
Owner

@DecisionNerd DecisionNerd commented Feb 1, 2026

Summary

Fixes CodeRabbit configuration file to use only valid v2 schema properties, eliminating validation warnings.

Problem

CodeRabbit was showing validation errors:

⚠️ Parsing warnings (1)
Validation error: Unrecognized key(s) in object: 'python', 'ignore', 'tools', 
'file_types', 'comments', 'thresholds', 'integrations', 'notifications'

Solution

Removed all unrecognized properties and kept only valid v2 schema properties:

❌ Removed (not in v2 schema):

  • python - Language-specific settings not supported
  • ignore - Use path_filters instead
  • tools - Tool configuration not exposed in config
  • file_types - File type handling not configurable
  • comments - Comment styling not configurable
  • thresholds - Complexity thresholds not configurable
  • integrations - Integration settings not configurable
  • notifications - Notification settings not configurable

✅ Kept (valid v2 schema):

  • language, early_access
  • reviews with:
    • profile, auto_review, path_filters, instructions
  • chat with auto_reply

Changes

  • Cleaned up .coderabbit.yaml to minimal valid configuration
  • Added YAML language server schema reference for editor validation
  • Kept all important review instructions and path filters

Testing

  • YAML validation passes with schema reference
  • Configuration is now compliant with CodeRabbit v2 schema
  • All custom review instructions preserved

Checklist

  • Configuration validated against schema
  • CHANGELOG updated
  • No functionality lost (only removed unsupported options)
  • Added schema reference for editor validation

Summary by CodeRabbit

  • Chores
    • Simplified the review configuration to a leaner, review-focused setup while preserving core automation.
    • Expanded reviewer instructions with additional quality checks for correctness, error handling, tests, docstrings, performance, security, and compatibility.
    • Added guidance to prefer small PRs and flag temporary/bandaid fixes.

✏️ Tip: You can customize this high-level summary in your review settings.

@DecisionNerd DecisionNerd added ci-cd CI/CD configuration changes release:none No release needed (docs/CI only) labels Feb 1, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 1, 2026

Walkthrough

The .coderabbit.yaml file was simplified: many nested configuration sections (checks, auto_approve, language/tool settings, ignore rules, integrations, notifications) were removed and replaced by a lean review-focused structure with expanded reviewer instructions.

Changes

Cohort / File(s) Summary
Configuration Simplification
.coderabbit.yaml
Removed extensive nested configuration (checks, auto_approve blocks, language-specific settings, ignore rules, tools, file type handling, comment/threshold settings, integrations, notifications). Kept core review automation fields (auto_review.enabled, drafts, base_branches, path_filters) and replaced detailed tooling config with concise review directives; expanded custom review instructions (openCypher semantics, error handling, test coverage, docstrings, performance, security, backward compatibility, TCK validation). Flags added for small PR preference and to call out bandaid fixes/workarounds.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly addresses the main change: fixing CodeRabbit configuration schema validation by removing unrecognized v2 schema properties.
Description check ✅ Passed The description covers problem statement, solution details, changes made, and testing verification. However, it lacks the structured template format with type of change selection, related issues link, and testing checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/coderabbit-config

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.coderabbit.yaml (1)

32-44: ⚠️ Potential issue | 🔴 Critical

instructions is not a valid property under reviews in the v2 schema.

The schema defines "additionalProperties": false for the reviews object, and instructions (as a plain array of strings) is not a recognized property. This will produce the same validation warnings the PR aims to fix.

To provide review guidance, use path_instructions with a wildcard pattern instead:

🔧 Proposed fix using path_instructions
-  # Custom review instructions for GraphForge
-  instructions:
-    - Focus on correctness of openCypher semantics
-    - Check for proper error handling and type safety
-    - Verify test coverage for new features
-    - Ensure docstrings are present for public APIs
-    - Check for performance implications in query execution
-    - Validate that changes maintain TCK compliance
-    - Look for potential security issues (SQL injection patterns, etc.)
-    - Verify backward compatibility for API changes
-    - Prefer small, focused PRs (< 300 lines)
-    - Flag any bandaid fixes or workarounds
+  # Custom review instructions for GraphForge
+  path_instructions:
+    - path: "**/*"
+      instructions: |
+        - Focus on correctness of openCypher semantics
+        - Check for proper error handling and type safety
+        - Verify test coverage for new features
+        - Ensure docstrings are present for public APIs
+        - Check for performance implications in query execution
+        - Validate that changes maintain TCK compliance
+        - Look for potential security issues (SQL injection patterns, etc.)
+        - Verify backward compatibility for API changes
+        - Prefer small, focused PRs (< 300 lines)
+        - Flag any bandaid fixes or workarounds

Remove unrecognized properties that caused validation errors:
- python (not part of v2 schema)
- ignore (use path_filters instead)
- tools (not configurable)
- file_types (not part of v2 schema)
- comments (not part of v2 schema)
- thresholds (not part of v2 schema)
- integrations (not part of v2 schema)
- notifications (not part of v2 schema)

Keep only valid v2 schema properties:
- language, early_access
- reviews (profile, auto_review, path_filters, instructions)
- chat

Add YAML language server schema reference for editor validation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@DecisionNerd DecisionNerd force-pushed the fix/coderabbit-config branch from 9a13fa7 to 871fcdc Compare February 1, 2026 12:54
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.coderabbit.yaml (1)

32-43: ⚠️ Potential issue | 🟠 Major

Replace unsupported reviews.instructions (Line 33) with reviews.path_instructions.

reviews disallows unknown keys, so using instructions directly will fail schema validation. The supported mechanism is path_instructions, which accepts a list of path-scoped instruction objects. Restructure your custom review guidance as shown below:

✅ Suggested schema‑compliant rewrite
-  # Custom review instructions for GraphForge
-  instructions:
-    - Focus on correctness of openCypher semantics
-    - Check for proper error handling and type safety
-    - Verify test coverage for new features
-    - Ensure docstrings are present for public APIs
-    - Check for performance implications in query execution
-    - Validate that changes maintain TCK compliance
-    - Look for potential security issues (SQL injection patterns, etc.)
-    - Verify backward compatibility for API changes
-    - Prefer small, focused PRs (< 300 lines)
-    - Flag any bandaid fixes or workarounds
+  # Custom review instructions for GraphForge
+  path_instructions:
+    - path: "**/*"
+      instructions: |
+        - Focus on correctness of openCypher semantics
+        - Check for proper error handling and type safety
+        - Verify test coverage for new features
+        - Ensure docstrings are present for public APIs
+        - Check for performance implications in query execution
+        - Validate that changes maintain TCK compliance
+        - Look for potential security issues (SQL injection patterns, etc.)
+        - Verify backward compatibility for API changes
+        - Prefer small, focused PRs (< 300 lines)
+        - Flag any bandaid fixes or workarounds

@DecisionNerd DecisionNerd merged commit 9cc0b82 into main Feb 1, 2026
17 checks passed
@DecisionNerd DecisionNerd deleted the fix/coderabbit-config branch February 1, 2026 12:59
DecisionNerd added a commit that referenced this pull request May 4, 2026
- Create v0.3.10 release story (#448): NetworkX/igraph export + parse cache
- Move #391 to v0.3.10; reorder milestones (#6=v0.3.10, #7=v0.4.0)
- README roadmap table: mark v0.3.9 in-progress, add v0.3.10 row
- docs/releases/roadmap.md: full rewrite reflecting v0.3.8 released,
  v0.3.9 in-progress, v0.3.10/v0.4.0/v1.0 planned with accurate scope

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-cd CI/CD configuration changes release:none No release needed (docs/CI only)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant