Skip to content

Conversation

@sentrivana
Copy link
Contributor

@sentrivana sentrivana commented Nov 27, 2025

Add a page to help frame discussions about breaking changes in SDKs. Discuss examples of breaking changes as well as changes which are not apparently breaking, but we need to be mindful of them because they significantly affect the user's Sentry experience. And finally, provide some tips on making breaking changes in a way that introduces less friction.

Direct link to preview: https://develop-docs-git-ivana-breaking-changes.sentry.dev/sdk/processes/breaking_changes/

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Nov 27, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Nov 28, 2025 4:23pm
sentry-docs Ready Ready Preview Comment Nov 28, 2025 4:23pm

@sentrivana sentrivana changed the title feat: Document breaking changes in SDK feat: Introducing breaking changes to SDKs doc Nov 28, 2025
@sentrivana sentrivana changed the title feat: Introducing breaking changes to SDKs doc feat: Doc on introducing breaking changes to SDKs Nov 28, 2025
Copy link
Member

@HazAT HazAT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two comments, otherwise lgtm
thank you

sentrivana and others added 2 commits November 28, 2025 17:12
Co-authored-by: Daniel Griesser <daniel.griesser.86@gmail.com>
@codecov
Copy link

codecov bot commented Nov 28, 2025

Bundle Report

Changes will increase total bundle size by 2.02MB (6.03%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
sentry-docs-server-cjs 24.9MB 2.02MB (8.82%) ⬆️⚠️
sentry-docs-client-array-push 10.22MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js 39.49kB 5.5MB 0.72%
6529.js 39.48kB 4.92MB 0.81%
../instrumentation.js 39.51kB 4.82MB 0.83%
../app/[[...path]]/page.js.nft.json 633.34kB 1.1MB 136.34% ⚠️
../app/platform-redirect/page.js.nft.json 633.34kB 1.1MB 136.36% ⚠️
../app/sitemap.xml/route.js.nft.json 633.34kB 1.1MB 137.09% ⚠️
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 893.1kB -0.0%
static/chunks/9366-*.js -3 bytes 436.99kB -0.0%
static/KN8UzCSruEPz_R2zyDnUI/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/KN8UzCSruEPz_R2zyDnUI/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/D7OpGgu1-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/D7OpGgu1-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants