docs(versioning): add schema-publication-at-merge policy#3391
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2366
Adds a
### Schema publication at mergesubsection todocs/reference/versioning.mdx, placed immediately after the existing### Breaking-change noticesection. The section codifies the invariant: the latest published tag and source HEAD must always reflect the same required-field set, and any PR that changes arequiredarray, a discriminatorconst, or tightens a validation constraint must be accompanied by a new tag cut before the change propagates to evaluators.The root case (source↔published drift from PR #2315 on the rc.3 tag) is resolved by the 3.0 GA tag. This doc addition is the durable Evergreen fix: it names the invariant, explains why the drift matters for pinned-tag and alias-resolving implementors alike, covers RC cycles explicitly, and describes manual responsibility until a CI check enforces the rule.
Non-breaking justification: adds a new subsection to an existing docs page; no schema changes, no wire changes, no API surface affected.
Pre-PR review:
code-reviewer: approved — no blockers; nits on wording and changeset style noted, addressed in revision (reviewer trigger condition changed from commit-prefix to actual schema-change categories; "staged or already cut" → "ready to publish"; redundant RC-cycle sentence removed)docs-expert: two blockers on initial draft: (1) conflict with the 3.x stability table's deprecation-first rule for optional→required; (2) "Why" block incorrectly scoped to alias users only. Both fixed: added "in addition to any upstream obligations" clause; broadened "Why" to cover pinned-tag implementors; added cross-link to/docs/building/schemas-and-sdks#schema-versioning.Session: https://claude.ai/code/session_01PKwE7MvNkQjTBaWssihqjj
Generated by Claude Code