Skip to content

docs: Sync compatibility docs to the pin-based version model#1507

Merged
hatayama merged 2 commits into
v3-betafrom
docs/sync-version-gate-model
Jul 5, 2026
Merged

docs: Sync compatibility docs to the pin-based version model#1507
hatayama merged 2 commits into
v3-betafrom
docs/sync-version-gate-model

Conversation

@hatayama

@hatayama hatayama commented Jul 5, 2026

Copy link
Copy Markdown
Owner

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 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
  • Update the CodeRabbit path instructions accordingly

Validation

Docs-only change; grep sweep confirms no remaining references to the deleted constants, guard, or fields outside historical fixtures.

Review in cubic

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
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@hatayama, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 38 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: beaaae0c-9c52-4170-8578-2e9b0fa019ef

📥 Commits

Reviewing files that changed from the base of the PR and between 53a6e0e and f49029c.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md
📝 Walkthrough

Walkthrough

Updated documentation in .coderabbit.yaml and AGENTS.md replacing guidance on updating CliConstants.MINIMUM_REQUIRED_PROJECT_RUNNER_VERSION with rules for release-please-managed projectRunnerVersion, CI-enforced protocol checks, and additive-only evolution of the project runner pin file.

Changes

Documentation Update for Protocol Versioning

Layer / File(s) Summary
Protocol bump and project runner pin guidance
.coderabbit.yaml, AGENTS.md
Replaces prior guidance on manually updating CliConstants.MINIMUM_REQUIRED_PROJECT_RUNNER_VERSION with instructions tying projectRunnerVersion to release-please and CI (check-protocol-minimum-version), documents the stamped files/fields including dispatcher contract stamping, adds a "Project Runner Pin" section requiring additive-only field evolution for Packages/src/project-runner-pin.json and its .uloop/ mirror, and clarifies that CI fails when release inputs change without matching triggers.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the docs update to the pin-based compatibility model.
Description check ✅ Passed The description matches the changeset, describing the compatibility docs and CodeRabbit guidance updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 docs/sync-version-gate-model

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 18bf780 and 53a6e0e.

📒 Files selected for processing (2)
  • .coderabbit.yaml
  • AGENTS.md

Comment thread .coderabbit.yaml Outdated
Comment thread AGENTS.md Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

2 issues found across 2 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread .coderabbit.yaml Outdated
Comment thread AGENTS.md Outdated
"Exactly two fields" and "keep exactly its current fields" read as a
frozen schema, contradicting the additive-only rule in the same section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant