From e56d926fcec100acb7ee247b456f282365869824 Mon Sep 17 00:00:00 2001 From: lucas Date: Mon, 17 Mar 2025 16:00:54 -0300 Subject: [PATCH 1/4] add v2 upgrade details --- .../v1-to-v2/angular-v8-to-v9/index.mdx | 9 ++++++ .../v1-to-v2/fuze-v8-to-v9/index.mdx | 9 ++++++ .../capacitor/migration/v1-to-v2/index.mdx | 28 +++++++++++++++++++ .../v1-to-v2/react-v8-to-v9/index.mdx | 9 ++++++ .../migration/v1-to-v2/vue-v8-to-v9/index.mdx | 9 ++++++ 5 files changed, 64 insertions(+) create mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx create mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx create mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx create mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx create mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx new file mode 100644 index 00000000000000..a49d5d5a01f2a7 --- /dev/null +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx @@ -0,0 +1,9 @@ +--- +title: Angular SDK migration from 8.x to 9.x +sidebar_order: 1 +description: "Learn about migrating from Sentry Angular SDK 8.x to 9.x" +--- + + + + diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx new file mode 100644 index 00000000000000..af2c373fadd36f --- /dev/null +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx @@ -0,0 +1,9 @@ +--- +title: Fuze SDK migration from 8.x to 9.x +sidebar_order: 2 +description: "Learn about migrating from Sentry Fuze SDK 8.x to 9.x" +--- + + + + diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx new file mode 100644 index 00000000000000..5c233e418f6a6c --- /dev/null +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx @@ -0,0 +1,28 @@ +--- +title: Migrate from 1.x to 2.x +sidebar_order: 7920 +description: "Learn about migrating from Sentry Capacitor SDK 1.x to 2.x" +--- + +Version 1 of the Sentry Capacitor SDK primarily introduces API cleanup and version support changes. + +This update contains behavioral changes that will not be caught by type checkers, linters, or tests, so we recommend carefully reading through the entire migration guide instead of relying on automatic tooling. + +Version 9 of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v8). Lower versions may continue to work, but may not support all features. + +### TypeScript Version Policy + +In preparation for v2 of the OpenTelemetry SDK, the minimum required TypeScript version is increased to version `5.0.4`. + + +## How to upgrade to SDK version 2: + +When upgrading to SDK version 2, please note the main breaking changes with Sentry JavaScript SDK. More detailed information about breaking changes in the sibling SDKs can be found in the [Sibling Migration guide](#sibling-migration-guide) + +- Capacitor V2 requires Sentry JavaScript SDK on version 9.x. We recommend reading below migration guide docs to find out how to address any breaking changes when upgrading the sibling dependencies to version 9. + +## Sibling migration guide + +Each Sibling SDK has specific changes in version 9. Follow the tutorials below to update your SDK. + + \ No newline at end of file diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx new file mode 100644 index 00000000000000..382d9653a58cf2 --- /dev/null +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx @@ -0,0 +1,9 @@ +--- +title: React SDK migration from 8.x to 9.x +sidebar_order: 3 +description: "Learn about migrating from Sentry React SDK 8.x to 9.x" +--- + + + + diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx new file mode 100644 index 00000000000000..a68079e294298e --- /dev/null +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx @@ -0,0 +1,9 @@ +--- +title: Vue SDK migration from 8.x to 9.x +sidebar_order: 4 +description: "Learn about migrating from Sentry Vue SDK 8.x to 9.x" +--- + + + + From 8bfb1a77318e40d7f8018dac64056d493662f67b Mon Sep 17 00:00:00 2001 From: lucas Date: Mon, 17 Mar 2025 19:06:40 -0300 Subject: [PATCH 2/4] use redirect instead of new pages for sibling sdks. Rephrasing --- .../migration/v1-to-v2/angular-v8-to-v9/index.mdx | 9 --------- .../migration/v1-to-v2/fuze-v8-to-v9/index.mdx | 9 --------- .../guides/capacitor/migration/v1-to-v2/index.mdx | 15 +++++++++++---- .../migration/v1-to-v2/react-v8-to-v9/index.mdx | 9 --------- .../migration/v1-to-v2/vue-v8-to-v9/index.mdx | 9 --------- package.json | 3 ++- 6 files changed, 13 insertions(+), 41 deletions(-) delete mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx delete mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx delete mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx delete mode 100644 docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx deleted file mode 100644 index a49d5d5a01f2a7..00000000000000 --- a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/angular-v8-to-v9/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Angular SDK migration from 8.x to 9.x -sidebar_order: 1 -description: "Learn about migrating from Sentry Angular SDK 8.x to 9.x" ---- - - - - diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx deleted file mode 100644 index af2c373fadd36f..00000000000000 --- a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/fuze-v8-to-v9/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Fuze SDK migration from 8.x to 9.x -sidebar_order: 2 -description: "Learn about migrating from Sentry Fuze SDK 8.x to 9.x" ---- - - - - diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx index 5c233e418f6a6c..60234ac1f4d8a8 100644 --- a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx @@ -4,7 +4,7 @@ sidebar_order: 7920 description: "Learn about migrating from Sentry Capacitor SDK 1.x to 2.x" --- -Version 1 of the Sentry Capacitor SDK primarily introduces API cleanup and version support changes. +Version 2 of the Sentry Capacitor SDK primarily introduces API cleanup and version support changes. This update contains behavioral changes that will not be caught by type checkers, linters, or tests, so we recommend carefully reading through the entire migration guide instead of relying on automatic tooling. @@ -17,12 +17,19 @@ In preparation for v2 of the OpenTelemetry SDK, the minimum required TypeScript ## How to upgrade to SDK version 2: -When upgrading to SDK version 2, please note the main breaking changes with Sentry JavaScript SDK. More detailed information about breaking changes in the sibling SDKs can be found in the [Sibling Migration guide](#sibling-migration-guide) +- Capacitor V2 requires Sentry JavaScript SDK on version 9.x. We recommend reading below [migration guide](#sibling-migration-guide) docs to find out how to address any breaking changes when upgrading to the sibling SDK. -- Capacitor V2 requires Sentry JavaScript SDK on version 9.x. We recommend reading below migration guide docs to find out how to address any breaking changes when upgrading the sibling dependencies to version 9. + +To prevent issues, use fixed versions of Sentry Capacitor and the Sibling SDK. Always install the Sibling SDK version that matches Sentry Capacitor. + ## Sibling migration guide -Each Sibling SDK has specific changes in version 9. Follow the tutorials below to update your SDK. +Each Sibling SDK has specific changes in version 9. Follow the tutorials below to update the SDK. + +- [Angular SDK 8.x to 9.x migration guide](/platforms/javascript/guides/angular/migration/v8-to-v9/). +- [React SDK 8.x to 9.x migration guide](/platforms/javascript/guides/react/migration/v8-to-v9/). +- [Vue SDK 8.x to 9.x migration guide](/platforms/javascript/guides/vue/migration/v8-to-v9/). +- [Nuxt SDK 8.x to 9.x migration guide](/platforms/javascript/guides/nuxt/migration/v8-to-v9/). \ No newline at end of file diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx deleted file mode 100644 index 382d9653a58cf2..00000000000000 --- a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/react-v8-to-v9/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: React SDK migration from 8.x to 9.x -sidebar_order: 3 -description: "Learn about migrating from Sentry React SDK 8.x to 9.x" ---- - - - - diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx deleted file mode 100644 index a68079e294298e..00000000000000 --- a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/vue-v8-to-v9/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Vue SDK migration from 8.x to 9.x -sidebar_order: 4 -description: "Learn about migrating from Sentry Vue SDK 8.x to 9.x" ---- - - - - diff --git a/package.json b/package.json index 856ac79221b4db..c6097fd1b4856b 100644 --- a/package.json +++ b/package.json @@ -137,5 +137,6 @@ "volta": { "node": "20.11.0", "yarn": "1.22.22" - } + }, + "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" } From 3535948d073031747cbb24ba5a0074768c1fab9d Mon Sep 17 00:00:00 2001 From: lucas Date: Mon, 17 Mar 2025 19:07:09 -0300 Subject: [PATCH 3/4] remove corepack change --- package.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/package.json b/package.json index c6097fd1b4856b..856ac79221b4db 100644 --- a/package.json +++ b/package.json @@ -137,6 +137,5 @@ "volta": { "node": "20.11.0", "yarn": "1.22.22" - }, - "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" + } } From 72516ea8d24e049bf610696049fad8687c2fde3a Mon Sep 17 00:00:00 2001 From: LucasZF Date: Thu, 20 Mar 2025 09:47:32 -0300 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> --- .../javascript/guides/capacitor/migration/v1-to-v2/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx index 60234ac1f4d8a8..41b14f42b68787 100644 --- a/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx +++ b/docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx @@ -8,7 +8,7 @@ Version 2 of the Sentry Capacitor SDK primarily introduces API cleanup and versi This update contains behavioral changes that will not be caught by type checkers, linters, or tests, so we recommend carefully reading through the entire migration guide instead of relying on automatic tooling. -Version 9 of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v8). Lower versions may continue to work, but may not support all features. +Version 2 of the SDK is compatible with Sentry self-hosted versions 24.4.2 or higher (unchanged from v1). Lower versions may continue to work, but may not support all features. ### TypeScript Version Policy @@ -17,7 +17,7 @@ In preparation for v2 of the OpenTelemetry SDK, the minimum required TypeScript ## How to upgrade to SDK version 2: -- Capacitor V2 requires Sentry JavaScript SDK on version 9.x. We recommend reading below [migration guide](#sibling-migration-guide) docs to find out how to address any breaking changes when upgrading to the sibling SDK. +- Capacitor version 2 depends on Sentry JavaScript SDK version 9. We recommend reading below [migration guide](#sibling-migration-guide) docs to find out how to address any breaking changes when upgrading the sibling SDKs. To prevent issues, use fixed versions of Sentry Capacitor and the Sibling SDK. Always install the Sibling SDK version that matches Sentry Capacitor.