Skip to content

feat(Capacitor): Migration guides for version 2 #13022

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
Apr 29, 2025
Merged

feat(Capacitor): Migration guides for version 2 #13022

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e56d926
add v2 upgrade details
lucas-zimerman Mar 17, 2025
8bfb1a7
use redirect instead of new pages for sibling sdks. Rephrasing
lucas-zimerman Mar 17, 2025
3535948
remove corepack change
lucas-zimerman Mar 17, 2025
72516ea
Apply suggestions from code review
lucas-zimerman Mar 20, 2025
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
35 changes: 35 additions & 0 deletions docs/platforms/javascript/guides/capacitor/migration/v1-to-v2/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
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 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.

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

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:

- 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.

<Alert level="warning" title="Important">
To prevent issues, use fixed versions of Sentry Capacitor and the Sibling SDK. Always install the Sibling SDK version that matches Sentry Capacitor.
</Alert>

## Sibling migration guide

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/).

<PageGrid/>
Loading