Skip to content

docs(migration): Add TLDR to v7 migration docs #5041

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.

Sign up for GitHub

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 4 commits into from
May 5, 2022
Merged

docs(migration): Add TLDR to v7 migration docs #5041

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a9cf03
docs(migration): Add TLDR to v7 migration docs
lforst May 5, 2022
206b7dc
Add comma
lforst May 5, 2022
6f44357
Add removal of eventStatusFromHttpCode
lforst May 5, 2022
88dbdfc
Change wording to clarify who the tldr section applies to
lforst May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
The main goal of version 7 is to reduce bundle size. This version is breaking because we removed deprecated APIs, upgraded our build tooling, and restructured npm package contents.
Below we will outline all the breaking changes you should consider when upgrading.

**TL;DR** If you only use basic features of Sentry, or you simply copy & pasted the setup examples from our docs, here's what changed for you:
- Our CDN bundles are now ES6 - you will need to [reconfigure your script tags](#renaming-of-cdn-bundles) if you want to keep supporting ES5 and IE11 on the new SDK version.
- Distributed CommonJS files will be ES6. Use a transpiler if you need to support old node versions.
- We bumped the TypeScript version we generate our types with to 3.8.3. Please check if your TypeScript projects using TypeScript version 3.7 or lower still compile. Otherwise, upgrade your TypeScript version.
- `whitelistUrls` and `blacklistUrls` have been renamed to `allowUrls` and `denyUrls` in the `Sentry.init()` options.
- The `UserAgent` integration is now called `HttpContext`.

## Dropping Support for Node.js v6

Node.js version 6 has reached end of life in April 2019. For Sentry JavaScript SDK version 7, we will no longer be supporting version 6 of Node.js.
Expand Down Expand Up @@ -252,7 +259,6 @@ favor of string literals.

### Removed Enums
* The previously deprecated enum `Status` was removed (see [#4891](https://github.com/getsentry/sentry-javascript/pull/4891)).
[This example](#status) explains how to migrate.
* The previously deprecated internal-only enum `RequestSessionStatus` was removed (see
[#4889](https://github.com/getsentry/sentry-javascript/pull/4889)) in favor of string literals.
* The previously deprecated internal-only enum `SessionStatus` was removed (see
Expand Down Expand Up @@ -284,6 +290,7 @@ For our efforts to reduce bundle size of the SDK we had to remove and refactor p
- Remove support for Opera browser pre v15.
- Rename `UserAgent` integration to `HttpContext`. (see [#5027](https://github.com/getsentry/sentry-javascript/pull/5027))
- Remove `SDK_NAME` export from `@sentry/browser`, `@sentry/node`, `@sentry/tracing` and `@sentry/vue` packages.
- Removed `eventStatusFromHttpCode` to save on bundle size.

## Sentry Angular SDK Changes

Expand Down