Skip to content

Commit 7a2db7b

Browse files
feat(Capacitor): Migration guides for version 2 (#13022)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR This PR adds migration guides to the new major version of Sentry Capacitor. It includes simple redirects for each sibling so the documentation stays correct for each of them. ## 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.): <!-- ENTER DATE HERE --> - [x] Other deadline: <!-- ENTER DATE HERE --> 1 week - [ ] 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](https://github.com/orgs/getsentry/teams/docs) ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: Krystof Woldrich <[email protected]>
1 parent 4fa04d7 commit 7a2db7b

File tree

1 file changed

+35
-0
lines changed
  • docs/platforms/javascript/guides/capacitor/migration/v1-to-v2

1 file changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Migrate from 1.x to 2.x
3+
sidebar_order: 7920
4+
description: "Learn about migrating from Sentry Capacitor SDK 1.x to 2.x"
5+
---
6+
7+
Version 2 of the Sentry Capacitor SDK primarily introduces API cleanup and version support changes.
8+
9+
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.
10+
11+
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.
12+
13+
### TypeScript Version Policy
14+
15+
In preparation for v2 of the OpenTelemetry SDK, the minimum required TypeScript version is increased to version `5.0.4`.
16+
17+
18+
## How to upgrade to SDK version 2:
19+
20+
- 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.
21+
22+
<Alert level="warning" title="Important">
23+
To prevent issues, use fixed versions of Sentry Capacitor and the Sibling SDK. Always install the Sibling SDK version that matches Sentry Capacitor.
24+
</Alert>
25+
26+
## Sibling migration guide
27+
28+
Each Sibling SDK has specific changes in version 9. Follow the tutorials below to update the SDK.
29+
30+
- [Angular SDK 8.x to 9.x migration guide](/platforms/javascript/guides/angular/migration/v8-to-v9/).
31+
- [React SDK 8.x to 9.x migration guide](/platforms/javascript/guides/react/migration/v8-to-v9/).
32+
- [Vue SDK 8.x to 9.x migration guide](/platforms/javascript/guides/vue/migration/v8-to-v9/).
33+
- [Nuxt SDK 8.x to 9.x migration guide](/platforms/javascript/guides/nuxt/migration/v8-to-v9/).
34+
35+
<PageGrid/>

0 commit comments

Comments
 (0)