Skip to content

meta(v9): Add v9 migration guide #14296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Dec 11, 2024
Merged

meta(v9): Add v9 migration guide #14296

merged 9 commits into from
Dec 11, 2024

Conversation

lforst
Copy link
Contributor

@lforst lforst commented Nov 14, 2024

Ref #14289

This PR adds a migration guide for v9 we can iterate on. It is not the final migration guide.

We are keeping the v8 migration guide as the main one for now until v9 is released.

In future PRs we will

  • fill in more details as we know them.
  • move the draft v9 migration guide into this one. (only after we have officially cut the v8 branch)

@lforst lforst self-assigned this Nov 15, 2024
@lforst lforst removed their assignment Nov 25, 2024
@lforst lforst changed the base branch from develop to v9 December 11, 2024 14:38
@lforst lforst marked this pull request as ready for review December 11, 2024 14:50
@@ -0,0 +1,159 @@
# Upgrading from 8.x to 9.x
Copy link
Contributor Author

Choose a reason for hiding this comment

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

You might ask yourself what is this file doing here.

Well, I started off this PR with actually doing the full changes for v9, leading me to move the v8 migration guide into its separate file. This is actually quite a bit of work with changing the links and all that stuff.

For this reason I would actually keep this file here for when we do the official switch because I don't wanna throw away that work.

@@ -0,0 +1,1955 @@
# Upgrading from 7.x to 8.x
Copy link
Member

Choose a reason for hiding this comment

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

Given this is a duplicate of what's in MIGRATION.md, shall we avoid having this here for now? We can add it later when we formally make the switch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure

**DISCLAIMER: THIS MIGRATION GUIDE IS WORK IN PROGRESS**

Version 9 of the Sentry SDK concerns itself with API cleanup and compatibility updates.
This update contains behavioral changes that will not be caught by TypeScript or linters, so we recommend carefully reading the section on [Behavioral Changes](#2-behavior-changes).
Copy link
Member

Choose a reason for hiding this comment

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

meta: I just realized that our comments/docs are a mix of american and british english (for ex: behavioral vs. behavioural) because of me. I made it Behaviour in the v8 migration docs.

We should probably mandate american english spelling to match the docs (even though colour is vastly superior to color in every way).

@lforst lforst merged commit 32a1cff into v9 Dec 11, 2024
30 checks passed
@lforst lforst deleted the lforst-v9-migration-guide branch December 11, 2024 16:48
mydea pushed a commit that referenced this pull request Dec 13, 2024
mydea pushed a commit that referenced this pull request Dec 13, 2024
lforst added a commit that referenced this pull request Dec 13, 2024
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.

2 participants