Skip to content

docs: CodeRabbit v2 schema validation and configuration cleanup #786

@ashleyshaw

Description

@ashleyshaw

Description

Validation and cleanup of CodeRabbit v2 schema configuration to ensure the .coderabbit.yml configuration file complies with the latest CodeRabbit v2 schema specification.

Issues Fixed

1. Invalid Properties Removed

Removed invalid CodeRabbit v1 properties that are not supported in v2:

  • auto_labels (root-level)
  • auto_assign (root-level)
  • Duplicate auto_review (root-level) - note: nested auto_review under reviews may also need review

2. Schema Override Validation

Updated .schemas/coderabbit-overrides.v2.json:

  • Removed auto_review from required fields
  • Kept only path_filters as required property under reviews
  • Ensures override complies with v2 schema

3. Test Fixture Updated

Updated scripts/validation/__fixtures__/valid-coderabbit.yml:

  • Removed references to deprecated properties
  • Uses only valid CodeRabbit v2 properties for testing

4. Configuration Specification

Created .github/CodeRabbit-Config-Spec.md:

  • Comprehensive specification of CodeRabbit v2 configuration
  • Documents all 10 path-specific review instruction sets
  • Validation results confirming compliance

Files Changed

  • .coderabbit.yml — Removed invalid properties
  • .schemas/coderabbit-overrides.v2.json — Updated schema override
  • scripts/validation/__fixtures__/valid-coderabbit.yml — Updated test fixture
  • .github/CodeRabbit-Config-Spec.md — Created specification

Acceptance Criteria

References

Related Issues

Definition of Ready (DoR)

  • Documentation need is clear and well-defined
  • Related docs/issues or files linked
  • Acceptance criteria listed
  • Estimate added if relevant
  • Milestone/release assigned (if applicable)

Definition of Done (DoD)

  • Documentation meets org standards and guidelines
  • Changelog entry prepared for PR (CHANGELOG.md)
  • Documentation reviewed for clarity and accessibility
  • Screenshots/code examples included if relevant
  • PR uses correct branch prefix (docs/)

Metadata

Metadata

Assignees

Priority

Medium

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions