Repository navigation
docs(api): Document versioning, upgrades, deprecations and release candidates - #131218
Merged
Merged
Conversation
…ndidates The package README now says what each release bump means, how to upgrade, how deprecated endpoints and exports show up and how long they stay, and how to cut a release candidate. The automatic release preflight now leaves prereleases alone: while the latest api@ tag is a prerelease it skips, since a minor bump of 3.0.0-rc.0 would release 3.0.0. It also sorts prerelease tags before their stable release, so a stable release after a prerelease no longer looks older than it. Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
Contributor
|
🚨 Warning: This pull request contains Frontend and Backend changes! It's discouraged to make changes to Sentry's Frontend and Backend in a single pull request. The Frontend and Backend are not atomically deployed. If the changes are interdependent of each other, they must be separated into two pull requests and be made forward or backwards compatible, such that the Backend or Frontend can be safely deployed independently. Have questions? Please ask in the |
5 tasks
BYK
requested changes
Nov 16, 2026
BYK
approved these changes
Nov 16, 2026
2 tasks done
This branch was successfully deployed
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.
The
@sentry/apiREADME now has a "Versions and upgrades" section. It covers what each kind of release means, how to upgrade, how deprecated endpoints and exports show up and how long they stay, and how to ship a release candidate under npm'snexttag.Release candidates needed two fixes in
api-package-release-preflight.sh, which decides the automatic releases:api@tag is a prerelease. Without that, the next spec change's minor bump would turn3.0.0-rc.0into a stable3.0.0.The "removing an export waits for a major" rule is enforced by #131210, which is still open.
Part of #131204.
via @BYK.
--
View Session [Sentry]