Skip to content

docs(api): Document versioning, upgrades, deprecations and release candidates - #131218

Merged
BYK merged 2 commits into
masterfrom
docs/api-release-guidance
Nov 16, 2026
Merged

BYK merged 2 commits into
masterfrom
docs/api-release-guidance

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

The @sentry/api README 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's next tag.

Release candidates needed two fixes in api-package-release-preflight.sh, which decides the automatic releases:

  • It now skips while the latest api@ tag is a prerelease. Without that, the next spec change's minor bump would turn 3.0.0-rc.0 into a stable 3.0.0.
  • It now sorts a prerelease before its stable version. Without that, once any prerelease existed, every later run decided HEAD predated it and skipped forever.

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]

…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>
@sentry-junior
sentry-junior Bot requested review from a team as code owners November 16, 2026 11:41
@sentry-junior
sentry-junior Bot requested a review from a team as a code owner November 16, 2026 11:41
@sentry-junior
sentry-junior Bot requested a review from BYK November 16, 2026 11:41
@github-actions github-actions Bot added Scope: Frontend Automatically applied to PRs that change frontend components Scope: Backend Automatically applied to PRs that change backend components labels Nov 16, 2026
@github-actions

Copy link
Copy Markdown
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 #discuss-dev-infra channel.

Comment thread static/packages/api/README.md Resolved
@BYK
BYK merged commit 2e749b0 into master Nov 16, 2026
74 checks passed
@BYK
BYK deleted the docs/api-release-guidance branch November 16, 2026 13:28

This branch was successfully deployed

1 active deployment
Preview — fb998d5d Deployed Nov 16, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Backend Automatically applied to PRs that change backend components Scope: Frontend Automatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant