docs: Sync compatibility docs to the pin-based version model#1507
Conversation
AGENTS.md and the CodeRabbit guidance still described deleted machinery: the dispatcherContractVersion generation, the removed check-dispatcher-contract guard, the MINIMUM_REQUIRED_* constants, and the stamped default-tools.json version. Documentation now matches the implemented model: the IPC protocolVersion pair is the only integer generation, and the project runner pin (projectRunnerVersion + minimumDispatcherVersion) is the single source for cross-component requirements. - Document the pin's two fields, who reads them, and the additive-only format discipline that keeps forced updates reachable by old dispatchers - Point the protocol-bump workflow at the pin's release-please-stamped projectRunnerVersion instead of a hand-maintained constant
|
Warning Review limit reached
Next review available in: 38 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughUpdated documentation in ChangesDocumentation Update for Protocol Versioning
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.coderabbit.yaml:
- Around line 43-45: Clarify the project runner pin guidance so it preserves the
existing fields while allowing new ones to be added; the current wording in the
pin policy text is ambiguous. Update the language around the project-runner pin
section to say the pin must retain its current fields unchanged and may evolve
additively only, and keep the existing symbols and references to
Packages/src/project-runner-pin.json and .uloop/project-runner-pin.json aligned
with that meaning.
In `@AGENTS.md`:
- Around line 48-50: The pin schema wording in AGENTS.md is too rigid because
“has exactly two fields” implies the schema cannot grow, which conflicts with
the additive-only rule; update the description near the project-runner pin
guidance to say the pin currently has two required fields while preserving that
future changes must be additive. Keep the wording aligned with the existing
cross-component version requirement text and the CliPinSynchronizer-backed pin
references.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8d816ad5-568f-42b6-bc91-f1c65e333d95
📒 Files selected for processing (2)
.coderabbit.yamlAGENTS.md
There was a problem hiding this comment.
2 issues found across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
"Exactly two fields" and "keep exactly its current fields" read as a frozen schema, contradicting the additive-only rule in the same section.
Summary
Part 6 (final) of the version-gate consolidation (G4), following #1501/#1503/#1504/#1505/#1506. AGENTS.md and the CodeRabbit guidance still described deleted machinery: the
dispatcherContractVersiongeneration, the removedcheck-dispatcher-contractguard, theMINIMUM_REQUIRED_*constants, and the stampeddefault-tools.jsonversion. Documentation now matches the implemented model: the IPCprotocolVersionpair is the only integer generation, and the project runner pin (projectRunnerVersion+minimumDispatcherVersion) is the single source for cross-component requirements.projectRunnerVersioninstead of a hand-maintained constantValidation
Docs-only change;
grepsweep confirms no remaining references to the deleted constants, guard, or fields outside historical fixtures.