Repository navigation
docs(flutter): Add v10 migration guide and interactive checklist - #19390
Merged
Merged
Conversation
Document migration steps through 10.0.0-alpha.5, including platform requirements, API removals, and telemetry behavior changes. Co-Authored-By: Codex <noreply@openai.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
1 of 6 tasks
buenaflor
marked this pull request as ready for review
September 24, 2026 09:17
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Unresolved documentation and SDK behavior inconsistencies could mislead Flutter v10 users.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Adds Flutter v9-to-v10 migration documentation, an interactive checklist, agent prompt, and collection-specific progress support.
Changes:
- Adds 17 validated Flutter migration steps and shared guide content.
- Extends migration components and validation for multiple collections.
- Adds full and interactive migration guides with scoped progress storage.
| File | Summary |
|---|---|
src/components/migrationGuide/index.tsx |
Supports multiple migration collections and storage scopes. |
src/components/migrationGuide/index.spec.tsx |
Tests collection behavior and progress isolation. |
src/components/migrationGuide/client.tsx |
Accepts migration-specific progress storage. |
scripts/validate-migration-items.spec.ts |
Tests collection-aware migration validation. |
scripts/validate-migration-items.mjs |
Adds multi-collection validation. |
includes/migration/flutter-v10/telemetry-callbacks.mdx |
Adds telemetry callback migration guidance. |
includes/migration/flutter-v10/span-attributes.mdx |
Adds span attribute migration guidance. |
includes/migration/flutter-v10/sentry-packages.mdx |
Adds package migration guidance. |
includes/migration/flutter-v10/sensitive-content.mdx |
Adds sensitive-content migration guidance. |
includes/migration/flutter-v10/removed-apis.mdx |
Documents removed APIs. |
includes/migration/flutter-v10/native-failed-requests.mdx |
Adds native failed-request guidance. |
includes/migration/flutter-v10/minimum-versions.mdx |
Documents minimum versions. |
includes/migration/flutter-v10/logs-and-metrics.mdx |
Adds logs and metrics migration guidance. |
includes/migration/flutter-v10/http-error-capture.mdx |
Adds HTTP error capture guidance. |
includes/migration/flutter-v10/flutter-web.mdx |
Adds Flutter web migration guidance. |
includes/migration/flutter-v10/feature-flags.mdx |
Adds feature flag migration guidance. |
includes/migration/flutter-v10/error-processing.mdx |
Adds error processing migration guidance. |
includes/migration/flutter-v10/desktop-crash-reporting.mdx |
Adds desktop crash reporting guidance. |
includes/migration/flutter-v10/callback-failures.mdx |
Adds callback failure guidance. |
includes/migration/flutter-v10/apple-swift-package-manager.mdx |
Adds Apple Swift Package Manager guidance. |
includes/migration/flutter-v10/app-start.mdx |
Adds app-start migration guidance. |
includes/migration/flutter-v10/android-kotlin.mdx |
Adds Android Kotlin migration guidance. |
includes/flutter-v10-migration-overview.mdx |
Provides migration highlights. |
includes/flutter-v10-agent-migration.mdx |
Adds the agent-assisted migration prompt. |
docs/platforms/dart/guides/flutter/migration/v9-to-v10/interactive.mdx |
Adds the interactive checklist. |
docs/platforms/dart/guides/flutter/migration/v9-to-v10/index.mdx |
Adds the full migration guide. |
docs/platforms/dart/guides/flutter/migration/index.mdx |
Links the new migration resources. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Include the Android minimum and required minSdk setting in the shared migration guide content. Refs getsentry/sentry-dart#4049 Co-Authored-By: Codex <noreply@openai.com>
2 tasks
Document the planned SDK default change and the explicit transaction-mode fallback. Co-Authored-By: Codex <noreply@openai.com>
Update the checklist count and verify the stream-default item is loaded. Co-Authored-By: Codex <noreply@openai.com>
Show previous and new requirements together and identify Android minSdk in the table. Co-Authored-By: Codex <noreply@openai.com>
Clarify terminal unhandled sessions and sampled-out Dart errors in the migration guide. Co-Authored-By: Codex <noreply@openai.com>
Co-Authored-By: Codex <noreply@openai.com>
Keep the opening paragraph within the migration validator limit. Preserve the existing explanation of cross-request deduplication. Co-Authored-By: Codex <noreply@openai.com>
antonis
approved these changes
Oct 2, 2026
antonis
left a comment
Contributor
There was a problem hiding this comment.
LGTM 🚀
I did a manual proof reading and a fact check with Claude and didn't find any issues.
buenaflor
added a commit
that referenced
this pull request
Oct 9, 2026
Prepare the Flutter documentation for v10 as the recommended SDK version. Cover platform minimums and Swift Package Manager setup, current callbacks and defaults, logs and metrics, integration data, Replay masking and manual controls, release health, and profiling removal. Shared Dart content is updated where Flutter inherits it. Document the Windows/Linux Breakpad default and Crashpad override, terminal web `unhandled` sessions with JavaScript SDK 11, filtering callback failures and sampler fallbacks, and app-start breakdown spans with their binding requirements. This is the release-wide documentation companion to #19390. Merge with the v10 rollout. Closes getsentry/sentry-dart#4025 Manual Replay guidance follows [sentry-dart#4010](getsentry/sentry-dart#4010) and [sentry-dart#3992](getsentry/sentry-dart#3992), covering zero-rate setup, buffering, pause/resume, stop/restart, and flush behavior. ## IS YOUR CHANGE URGENT? - [ ] Urgent deadline (GA date, etc.): YYYY-MM-DD - [ ] Other deadline: YYYY-MM-DD - [x] No deadline: Not urgent, can wait up to 1 week+ Merge with the v10 rollout; no release date has been set here. ## PRE-MERGE CHECKLIST - [ ] 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 --------- Co-authored-by: Codex <noreply@openai.com>
1 of 6 tasks
ric-oliv
added a commit
that referenced
this pull request
Oct 29, 2026
<!-- Keep the urgency section so automation can prioritize this PR. You may delete other sections you don't need. --> ## DESCRIBE YOUR PR This PR adds the migration guide for version 7 of the Sentry SDK for .NET, ready for the public release candidate, `7.0.0-rc.2`. It follows the pattern of the Flutter v10 guide from #19390: - A full guide at `/platforms/dotnet/migration/v6-to-v7/`, built from one include per change in `includes/migration/dotnet-v7/`. - An interactive checklist at `/platforms/dotnet/migration/v6-to-v7/interactive/` that renders the same includes through `<MigrationGuide migration="dotnet-v7" />`. - An agent prompt callout that points at the guide's `.md` URL. - A "Migrating to 7.x" section at the top of the existing .NET migration page, which links to both. Both pages live under `common/`, so they render for every .NET guide, such as ASP.NET Core, MAUI, WPF and Serilog. Xamarin uses a separate SDK, so the new pages exclude it. I didn't move the 6.x, 4.x and 3.x sections, so every existing URL and anchor keeps working and the PR needs no redirects. To register the collection, the PR adds `dotnet-v7` to the `MIGRATIONS` map in the `MigrationGuide` component and to the validator's `COLLECTIONS` map, with specs for both. These changes in `src/components/migrationGuide/` and `scripts/` touch code that the JavaScript and Flutter guides share, so they need an approval from the docs team. For reference, msonnb approved the last change to the component in #19729, and andreiborza approved the JavaScript interactive guide that added it in #19076. The checklist shows one step only on the MAUI guide. Every other step applies to every .NET guide, because .NET apps combine integrations, such as a Serilog sink in an ASP.NET Core app. I checked the guide against `7.0.0-rc.2` from nuget.org and against the `version7` branch at getsentry/sentry-dotnet@a56c63455. The guide describes 7.0.0. Where rc.2 still behaves differently, the release candidate note at the top says so. ### Why this goes live during the release candidate I'd like to merge this as soon as it's approved, while 7.0 is still in release candidate. 7.0.0 GA is planned for 2026-11-30. People who try the release candidate need the guide now, and the agent prompt needs a published `.md` URL to point at. Two develop-docs rules pull in different directions here. [Managing Linear projects](https://develop.sentry.dev/sdk/getting-started/playbooks/coordination/managing-linear-projects/#visibility-for-major-releases) says docs "MUST NOT go live before the SDK ships". The [breaking changes playbook](https://develop.sentry.dev/sdk/getting-started/playbooks/sdk-lifecycle/breaking-changes/#6-update-docs-and-changelog) says to publish the migration guide "before or alongside the major release". I read the first rule as protecting users from docs for code they can't get. Version `7.0.0-rc.2` is public on nuget.org, and the guide's first block says it's a release candidate and names that version. Other SDKs made the same call: - The Python 2.0 guide merged on 2024-02-28, while only the `2.0.0a1` alpha was out. Its note at the top said so. - The JavaScript v11 guide merged on 2026-09-08 with `11.0.0-beta.1` out, and its interactive version followed on 2026-09-11. - The Flutter v10 guide merged on 2026-10-05 with `10.0.0-rc.2` out, four days before 10.0.0. ### The release candidate note The guide opens with one `<Alert>`. It says there is no stable 7.0 yet, names `7.0.0-rc.2`, and says the rest of the .NET docs describe 6.x until 7.0.0 ships. It also covers what only the release candidate has: - `Logging.AddSentry()` after `ClearProviders()` doesn't add Sentry's logger providers back yet. That came with getsentry/sentry-dotnet#5776, after rc.2. - `DecompressionMethods` still includes Brotli, which getsentry/sentry-dotnet#5816 takes out of the default after rc.2. The note says how to leave it out until then. - An ASP.NET Core app that sends `ILogger` entries through NLog crashes with `Debug` on, tracked in getsentry/sentry-dotnet#5822. The guide's verify step turns `Debug` on, so the note says to leave it off in those apps. - Its `net11.0` builds depend on the .NET 11 release candidate versions of three `Microsoft.Extensions` packages. The rest of the guide describes 7.0.0 as released. At GA, I'll delete that one block from `includes/dotnet-v7-migration-overview.mdx`, and nothing else needs to change. ### What this PR leaves to other PRs This PR only adds the guide and what it needs. The reference pages are in other PRs, and this one doesn't need any of them to merge first: - Logs and the logging integrations: #19925 - `Microsoft.Extensions.Logging` and ASP.NET Core: #19961 - OpenTelemetry propagation: #19924 - Release and environment: #19960 - Hangfire monitor schedules: #19781 Three links in the guide point to the "Apps That Call UseSentry" sections that #19925 adds to the Serilog, NLog and log4net guides. Until #19925 merges, they open those guides at the top, and the migration guide sums up the same setups itself. There is no page for the new `Sentry.Extensions.Hosting` package yet. I'll link it from the guide once that page exists. Refs https://linear.app/getsentry/issue/NET-860 Refs getsentry/sentry-dotnet#5710 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. Select exactly one option. For deadlines, replace `YYYY-MM-DD` with the due date. You can update this information later by editing the PR description. - [x] Urgent deadline (GA date, etc.): 2026-11-30 - [ ] Other deadline: YYYY-MM-DD - [ ] No deadline: Not urgent, can wait up to 1 week+ ## 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) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: James Crosswell <jamescrosswell@users.noreply.github.com> Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the Flutter v9-to-v10 migration with a dedicated full guide and a companion interactive checklist, matching the JavaScript migration experience. The guide covers platform requirements, removed APIs, and telemetry behavior changes for v10.
Closes getsentry/sentry-dart#4023
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES