diff --git a/src/includes/getting-started-primer/flutter.mdx b/src/includes/getting-started-primer/flutter.mdx index d3651a9ea1467..a9ff4bcdaab13 100644 --- a/src/includes/getting-started-primer/flutter.mdx +++ b/src/includes/getting-started-primer/flutter.mdx @@ -17,4 +17,4 @@ Features: - as well as `http` with the [Dart SDK](/platforms/dart/) - [Release Health](/product/releases/health/) tracks crash free users and sessions - Limited support for Flutter Web -- Under the hood the SDK relies on the [Dart SDK](/platforms/dart/); the minimum required version is `2.8.0` and Flutter SDK version is `1.17.0`. +- Under the hood the SDK relies on the [Dart SDK](/platforms/dart/); the minimum required version is `2.12.0` and Flutter SDK version is `1.17.0`. diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx new file mode 100644 index 0000000000000..d212c7771f54b --- /dev/null +++ b/src/platforms/dart/migration.mdx @@ -0,0 +1,22 @@ +--- +title: Migration Guide +sidebar_order: 1000 +--- + +## Migrating from `sentry` `4.0.x` to `sentry` `5.0.0` + +* Sentry's Dart SDK version 5.0.0 and above requires Dart 1.12.0 +* Fix: Prefix classes with Sentry + * A couple of classes were often conflicting with user's code. + As a result, this change renames the following classes: + * `App` -> `SentryApp` + * `Browser` -> `SentryBrowser` + * `Device` -> `SentryDevice` + * `Gpu` -> `SentryGpu` + * `Integration` -> `SentryIntegration` + * `Message` -> `SentryMessage` + * `OperatingSystem` -> `SentryOperatingSystem` + * `Orientation` -> `SentryOrientation` + * `Request` -> `SentryRequest` + * `User` -> `SentryUser` +* Return type of `Sentry.close()` changed from `void` to `Future` and `Integration.close()` changed from `void` to `FutureOr` diff --git a/src/platforms/dart/usage/advanced-usage.mdx b/src/platforms/dart/usage/advanced-usage.mdx index 36fac33d5724e..ac14a79b01480 100644 --- a/src/platforms/dart/usage/advanced-usage.mdx +++ b/src/platforms/dart/usage/advanced-usage.mdx @@ -5,7 +5,7 @@ sidebar_order: 2 ## Requirements -- For the usage of the Dart SDK, the minimal required Dart SDK version is `2.8.0` and Flutter SDK version is `1.17.0` +- For the usage of the Dart SDK, the minimal required Dart SDK version is `2.12.0`. ## Automatic Breadcrumbs diff --git a/src/platforms/flutter/migration.mdx b/src/platforms/flutter/migration.mdx new file mode 100644 index 0000000000000..5e3b7ce4777da --- /dev/null +++ b/src/platforms/flutter/migration.mdx @@ -0,0 +1,12 @@ +--- +title: Migration Guide +sidebar_order: 1000 +--- + +## Migrating from `sentry_flutter` `4.0.x` to `sentry_flutter` `5.0.0` + +In addition to the changes introduced in [sentry](/platforms/dart/migration/): + +* `SentryFlutterOptions.enableLifecycleBreadcrumbs` was replaced with `SentryFlutterOptions.enableAppLifecycleBreadcrumbs`. +* The Web Plugin Registrant import changed from `import 'package:sentry_flutter/src/sentry_flutter_web.dart';` to `import 'package:sentry_flutter/sentry_flutter_web.dart';` + * This change may lead to breaking changes. In most cases, however, this change won't lead to breaking changes since the referencing file is auto-generated.