docs: publish the API versioning and deprecation policy - #80
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
1 participant
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.
The policy existed and was already CI-enforced, but only internally:
.claude/rules/sdk-versioning.md,docs/DEPRECATIONS.md, and a gate that blocks an SDK major unless a repo variable names that exact version. None of it was readable by someone deciding whether to depend on the API, which is the only audience that matters for it.States what we will change without warning, what we treat as breaking, the expand/deprecate/contract lifecycle, how to detect a deprecated surface (OpenAPI
deprecated: true, JSDoc@deprecated, changelog), and what each SDK version bump means.No new promises. It writes down what the repo already does and enforces.