From 2ee22ff5ed033a34dc7fd7a0eaf5a93f3ea4f711 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Wed, 19 Jan 2022 11:56:15 -0500 Subject: [PATCH 1/5] meta: CHANGELOG for 6.17.0 - Add changelog for 6.17.0 - Update MIGRATION doc to reflect undeprecation of Severity enum --- CHANGELOG.md | 10 ++++++++-- MIGRATION.md | 18 +----------------- 2 files changed, 9 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f616022f90cd..adb1400d779a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,9 +4,15 @@ - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott -## 6.17.0-beta.0 +## 6.17.0 + +This release contains several internal refactors that help reduce the bundle size of the SDK and help prep for our [upcoming major release](https://github.com/getsentry/sentry-javascript/issues/4240). There are no breaking changes in this patch unless you are using our internal `Dsn` class. We also deprecated our typescript enums and our internal `API` class. We've detailed how to update your sdk usage if you are using the `Dsn` class or any of the deprecated methods in our [migration documentation](./MIGRATION.md#upgrading-from-6.x-to-6.17.0). -This beta releases contains several internal refactors that help reduce the bundle size of the SDK and help prep for our [upcoming major release](https://github.com/getsentry/sentry-javascript/issues/4240). There are no breaking changes in this patch unless you are using our internal `Dsn` class. We also deprecated our typescript enums and our internal `API` class. We've detailed how to update your sdk usage if you are using the `Dsn` class or any of the deprecated methods in our [migration documentation](./MIGRATION.md#upgrading-from-6.x-to-6.17.0). +- feat: Undeprecate Severity Enum (#4412) +- feat(core): Add processing metadata to scope and event (#4252) +- fix(nextjs): Inject sentry.x.config.js into pages/_error (#4397) + +## 6.17.0-beta.0 - feat(core): Deprecate API class (#4281) - feat(dsn): Remove Dsn class (#4325) diff --git a/MIGRATION.md b/MIGRATION.md index 299c427d4dbb..2a06da898abf 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -44,23 +44,7 @@ const envelopeEndpoint = api.getEnvelopeEndpointWithUrlEncodedAuth(); ## Enum changes -We've detailed how to migrate off our enums `Severity`, `Status` and `SpanStatus`. We also made changes to deprecate `TransactionMethod`, `Outcome` and `RequestSessionStatus` enums, but those are internal only APIs. - -#### Severity - -We deprecated the `Severity` enum in `@sentry/types` and it will be removed in the next major release. We recommend using string literals to save on bundle size. [PR](https://github.com/getsentry/sentry-javascript/pull/4280). We also removed the `Severity.fromString` method. This was done to save on bundle size. - -```js -// New in 6.17.0: -import { severityFromString } from '@sentry/utils'; - -const severity = severityFromString(level); - -// Before: -import { Severity } from '@sentry/types'; - -const severity = Severity.fromString(level); -``` +We've detailed how to migrate off the enums `Status` and `SpanStatus`. We also made changes to deprecate `TransactionMethod`, `Outcome` and `RequestSessionStatus` enums, but those are internal only APIs. #### Status From b7fa3aaac4c87c626d4fe0c5608c371b4a18f580 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Wed, 19 Jan 2022 15:59:05 -0500 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Katie Byers --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index adb1400d779a..8145e72e8f69 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ ## 6.17.0 -This release contains several internal refactors that help reduce the bundle size of the SDK and help prep for our [upcoming major release](https://github.com/getsentry/sentry-javascript/issues/4240). There are no breaking changes in this patch unless you are using our internal `Dsn` class. We also deprecated our typescript enums and our internal `API` class. We've detailed how to update your sdk usage if you are using the `Dsn` class or any of the deprecated methods in our [migration documentation](./MIGRATION.md#upgrading-from-6.x-to-6.17.0). +This release contains several internal refactors that help reduce the bundle size of the SDK and help prep for our [upcoming major release](https://github.com/getsentry/sentry-javascript/issues/4240). There are no breaking changes in this patch unless you are using our internal `Dsn` class, which has been removed. We also deprecated a few of our typescript enums and our internal `API` class. We've detailed in our [migration documentation](./MIGRATION.md#upgrading-from-6.x-to-6.17.0) how to update your sdk usage if you are using any of these in your code. - feat: Undeprecate Severity Enum (#4412) - feat(core): Add processing metadata to scope and event (#4252) From fc96d0ed54eb2ddc8ee9828657d68a772432141c Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Wed, 19 Jan 2022 16:02:22 -0500 Subject: [PATCH 3/5] adjust based on code review --- CHANGELOG.md | 7 ++----- MIGRATION.md | 8 ++++++-- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8145e72e8f69..6b6b29df04df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,14 +9,11 @@ This release contains several internal refactors that help reduce the bundle size of the SDK and help prep for our [upcoming major release](https://github.com/getsentry/sentry-javascript/issues/4240). There are no breaking changes in this patch unless you are using our internal `Dsn` class, which has been removed. We also deprecated a few of our typescript enums and our internal `API` class. We've detailed in our [migration documentation](./MIGRATION.md#upgrading-from-6.x-to-6.17.0) how to update your sdk usage if you are using any of these in your code. - feat: Undeprecate Severity Enum (#4412) +- feat: Remove Dsn class (#4325) - feat(core): Add processing metadata to scope and event (#4252) -- fix(nextjs): Inject sentry.x.config.js into pages/_error (#4397) - -## 6.17.0-beta.0 - - feat(core): Deprecate API class (#4281) -- feat(dsn): Remove Dsn class (#4325) - feat(ember): Update ember dependencies (#4253) +- fix(nextjs): Inject sentry.x.config.js into pages/_error (#4397) - fix(nextjs): Add sentry-cli existence check for enabling webpack plugin #4311 - ref(tracing): deprecate span status enum (#4299) - ref(types): drop unused logLevel (#4317) diff --git a/MIGRATION.md b/MIGRATION.md index 2a06da898abf..696ba13e84d5 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -44,7 +44,11 @@ const envelopeEndpoint = api.getEnvelopeEndpointWithUrlEncodedAuth(); ## Enum changes -We've detailed how to migrate off the enums `Status` and `SpanStatus`. We also made changes to deprecate `TransactionMethod`, `Outcome` and `RequestSessionStatus` enums, but those are internal only APIs. +The enums `Status` and `SpanStatus` were deprecated, and we've detailed how to migrate away from them below. We also deprecated the `TransactionMethod`, `Outcome` and `RequestSessionStatus` enums, but those are internal-only APIs. If you are using them, we encourage you to take a look at the corresponding PRs to see how we've changed our code as a result. + +- `TransactionMethod`: https://github.com/getsentry/sentry-javascript/pull/4314 +- `Outcome`: https://github.com/getsentry/sentry-javascript/pull/4315 +- `RequestSessionStatus`: https://github.com/getsentry/sentry-javascript/pull/4316 #### Status @@ -87,7 +91,7 @@ In this version upgrade, there are a few breaking changes. This guide should hel We moved optional integrations into their own package, called `@sentry/integrations`. Also, we made a few default integrations now optional. This is probably the biggest breaking change regarding the upgrade. -Integrations that are now opt-in and were default before: +Integrations that are now opt-in and were Wedefault before: - Dedupe (responsible for sending the same error only once) - ExtraErrorData (responsible for doing fancy magic, trying to extract data out of the error object using any From 04960b90b38c7137733a67440a0ac91f704e4af5 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Wed, 19 Jan 2022 16:03:30 -0500 Subject: [PATCH 4/5] spelling --- MIGRATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MIGRATION.md b/MIGRATION.md index 696ba13e84d5..8502d2030a4d 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -91,7 +91,7 @@ In this version upgrade, there are a few breaking changes. This guide should hel We moved optional integrations into their own package, called `@sentry/integrations`. Also, we made a few default integrations now optional. This is probably the biggest breaking change regarding the upgrade. -Integrations that are now opt-in and were Wedefault before: +Integrations that are now opt-in and were default before: - Dedupe (responsible for sending the same error only once) - ExtraErrorData (responsible for doing fancy magic, trying to extract data out of the error object using any From d0b98ab21d0e526a2aaafd37c572493c1f7bbdee Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Wed, 19 Jan 2022 16:23:47 -0500 Subject: [PATCH 5/5] add contribution --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b6b29df04df..2e85d13549e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,8 @@ This release contains several internal refactors that help reduce the bundle siz - ref(types): deprecate status enum (#4298) - ref(types): deprecate severity enum (#4280) +Work in this release contributed by @yordis. Thank you for your contribution! + ## 6.16.1 - feat(nextjs): Support Next.js v12 (#4093)