Skip to content
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

Jump to bottom

Capacitor: Add troubleshooting for Sibling SDKs #5656

Merged
merged 8 commits into from
Nov 18, 2022
Merged

Capacitor: Add troubleshooting for Sibling SDKs #5656

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b994acb
Add troubleshooting for sibling sdks
lucas-zimerman Oct 17, 2022
4a64040
Remove spaces
lucas-zimerman Oct 17, 2022
e9b6c79
Extra line
lucas-zimerman Oct 18, 2022
552a1c5
Apply suggestions from code review
lucas-zimerman Oct 19, 2022
674011f
Apply suggestions from code review
lucas-zimerman Oct 26, 2022
86b2da6
move error message to the top and extra line added
lucas-zimerman Nov 9, 2022
11befe5
Update src/platforms/javascript/guides/capacitor/troubleshooting.mdx
lucas-zimerman Nov 11, 2022
067d717
Update src/platforms/javascript/guides/capacitor/troubleshooting.mdx
lucas-zimerman Nov 17, 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
26 changes: 26 additions & 0 deletions src/platforms/javascript/guides/capacitor/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,32 @@ keywords: ["minimum version", "deployment target"]
sidebar_order: 1000
---

## Different Versions for Sibling SDKs

To avoid any issues when installing packages or using the code on another machine, you must use the same version of Sentry Capacitor and @Sentry/Angular (or any other sibling SDK) that is referred by the peer dependency of Sentry Capacitor in your app.
lucas-zimerman marked this conversation as resolved.
Show resolved Hide resolved

Correct:

```xml
"@sentry/angular": "7.13.0",
"@sentry/capacitor": "0.10.1"
```

Incorrect:

```xml
"@sentry/angular": "^7.13.0",
"@sentry/capacitor": "^0.10.1"
```

If you see the following error during build time, the sibling SDKs installed in your app have mismatched versions:

```js
node_modules/@sentry/types/types/globals.d.ts:2:11 - error TS2451: Cannot redeclare block-scoped variable '__DEBUG_BUILD__'.
```
lucas-zimerman marked this conversation as resolved.
Show resolved Hide resolved


You can verify the correct version of the sibling SDK using the following command: `npm info @sentry/capacitor peerDependencies`
lucas-zimerman marked this conversation as resolved.
Show resolved Hide resolved
## Capacitor 2 on iOS

Capacitor 3 has a minimum requirement of iOS 12.0. As a result, the Sentry SDK needs to match this requirement to support Capacitor 3. Users on older versions may run into an error similar to:
Expand Down
8 changes: 7 additions & 1 deletion src/wizard/capacitor/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Install the Sentry Capacitor SDK alongside the sibling Sentry Angular SDK:
npm install --save @sentry/capacitor @sentry/angular

# yarn
yarn add @sentry/capacitor @sentry/angular @sentry/tracing
yarn add @sentry/capacitor @sentry/angular @sentry/tracing --exact
```

Or install the standalone Sentry Capacitor SDK if you don't use Ionic/Angular:
Expand All @@ -25,6 +25,12 @@ npm install --save @sentry/capacitor @sentry/tracing
yarn add @sentry/capacitor
```

<Note>

The version of the sibling SDK must match with the version refered by Sentry Capacitor. To verify the correct version of the sibling SDK using the following command: `npm info @sentry/capacitor peerDependencies`
lucas-zimerman marked this conversation as resolved.
Show resolved Hide resolved

</Note>

## Capacitor 2 - Android Installation

<Note>
Expand Down