fix: make .coderabbit.yaml valid so the repo config is actually used - #34
Conversation
tone_instructions is capped at 250 characters by the CodeRabbit schema and
this file held 539, so the whole config failed validation and reviews silently
fell back to the org-level UI settings — none of the guidance here has been
taking effect.
The schema describes tone_instructions as a persona field ("Set the tone of
reviews and chat"), not a place for review rules, and gives
path_instructions 20000 characters. So the two repo-wide rules move to a
`**` path_instruction rather than being cut: don't repeat what ruff/mypy
already report, and don't flag pre-existing issues in moved or reformatted
code.
Nothing is lost. The rest of the old tone_instructions — public API
stability, network error handling, type hints on the public surface — was
already covered verbatim by the src/comfy_sdk/** entry.
Validated against https://coderabbit.ai/integrations/schema.v2.json: 1 error
before, 0 after.
|
Warning Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories. Warning
|
| Layer / File(s) | Summary |
|---|---|
Tone and path instruction placement .coderabbit.yaml |
tone_instructions is reduced to concise directives, while detailed review rules are placed under the "**" path filter due to the schema character limit. |
Suggested reviewers: alexisrolland
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
| Check name | Status | Explanation |
|---|---|---|
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
fix/coderabbit-config-schema
✨ Simplify code
- Create PR with simplified code
- Commit simplified code in branch
fix/coderabbit-config-schema
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.
Comment @coderabbitai help to get the list of available commands.
|
Correction + stronger evidence. I claimed in the description that this PR would be its own test — that CodeRabbit's review here should stop saying The reason is that CodeRabbit reads What I could do instead is test the hypothesis across repos. Comparing
The correlation is exact, and So the fix stands, but the confirmation has to come from the first CodeRabbit review on Separately: |
The bug
tone_instructionsis capped at 250 characters by the CodeRabbit schema. This file held 539, so the entire config failed validation — and CodeRabbit silently fell back to org-level UI settings rather than erroring. Evidence: recent reviews on this repo reportSo none of the reviewer guidance in this file has ever taken effect.
I verified this rather than taking the bot's word for it — fetched
https://coderabbit.ai/integrations/schema.v2.jsonand validated the file withjsonschema:That single field was the only error in the file.
The fix
The schema describes
tone_instructionsas a persona field — "Set the tone of reviews and chat. Example: 'You must talk like Mr. T.'" — not a place for substantive review rules. So rather than deleting ~290 characters of guidance to squeeze under the cap, the repo-wide rules move to apath: "**"entry, which has 20000 characters of room.No guidance is lost:
tone_instructionsclause**path_instruction**path_instructionsrc/comfy_sdk/**(unchanged)src/comfy_sdk/**(unchanged)src/comfy_sdk/**(unchanged)The last three were already duplicated verbatim in
path_instructions, so moving only the two genuinely cross-cutting rules keeps the diff minimal.tone_instructionsnow carries actual tone direction, which is what the field is for.How to confirm it worked
The next CodeRabbit review on this repo should stop saying
Configuration used: Organization UI. This PR is itself the first test.The sibling fix for
comfy-typescript-sdkis in that repo's PR.