README: add note about preview API stability#6314
Open
jeanregisser wants to merge 6 commits intomasterfrom
Open
README: add note about preview API stability#6314jeanregisser wants to merge 6 commits intomasterfrom
jeanregisser wants to merge 6 commits intomasterfrom
Conversation
jeanregisser
requested review from
davidme-stripe,
gbirch-stripe and
porter-stripe
davidme-stripe
requested changes
Apr 7, 2026
Contributor
davidme-stripe
left a comment
davidme-stripe
left a comment
There was a problem hiding this comment.
Discussing offline
jeanregisser
changed the title
Document the SDK's versioning policy, specifically: - All modules share a single version number - Breaking changes to @_spi (beta/preview) APIs require a MINOR bump - This is because podspecs use ~> X.Y.Z, so a breaking SPI change in a PATCH release could break consumers like stripe-react-native - @_spi APIs carry no long-term stability guarantees Committed-By-Agent: goose
Committed-By-Agent: claude
Committed-By-Agent: claude
jeanregisser
force-pushed
the
jeanregisser/versioning-docs
branch
from
3209bc1 to
0909f53
Compare
Added a section on preview APIs and their stability guarantees.
Added a note about the usage of @_spi(STP) APIs for internal use only.
davidme-stripe
previously approved these changes
Apr 8, 2026
Removed note about @_spi(STP) APIs being reserved for internal use.
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
2 participants
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.
Summary
Adds a small note to the README clarifying that
@_spi(preview/beta) APIs carry no stability guarantees and may have breaking changes in minor versions.Motivation
This came up in #6230 where a contributor was surprised that a breaking
@_spichange required a MINOR version bump. Discussed in the iOS team Slack thread.Testing
Documentation only.
Changelog
N/A