Skip to content

Update data driven fixes docs#186217

Merged
keertip merged 8 commits into
flutter:masterfrom
keertip:data-driven-docs
May 26, 2026
Merged

Update data driven fixes docs#186217
keertip merged 8 commits into
flutter:masterfrom
keertip:data-driven-docs

Conversation

@keertip

@keertip keertip commented May 7, 2026

Copy link
Copy Markdown
Contributor

Update the docs for data driven fixes with the addition of a new syntax for replacing libraries.

The change has landed in the Dart SDK and should be in flutter soon - dart-lang/sdk@18c1a3f

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label May 7, 2026
@github-actions github-actions Bot added c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. d: docs/ flutter/flutter/docs, for contributors labels May 7, 2026
@keertip keertip added team-devexp Owned by the Developer Experience team and removed c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. labels May 7, 2026
gemini-code-assist[bot]
gemini-code-assist Bot reviewed May 7, 2026
View reviewed changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the data-driven fixes documentation to introduce support for library-level transforms. It adds a new library key as an alternative to the element key and explains how to use the replacedBy change for library migrations. Review feedback identifies a typo in a link, an incorrect Markdown anchor, and a missing closing backtick in a YAML code block.

Comment thread docs/contributing/Data-driven-Fixes.md Outdated
```yaml
library: 'package:p/lib.dart'
```
Currently, the only transform that can be done on a library is a [`replaceby`](#replaceBy) change. For example, to replace a library `package:p/lib.dart` with a library

@gemini-code-assist gemini-code-assist Bot May 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link text replaceby contains a typo and should be replacedBy to match the section heading. Additionally, the anchor #replaceBy should be lowercase #replacedby to ensure the link works correctly, as Markdown anchors are typically lowercased by renderers like GitHub, and this matches the style used for other links in this document (e.g., #element, #library).

Comment thread docs/contributing/Data-driven-Fixes.md
@keertip keertip requested a review from bwilkerson May 7, 2026 21:02
@github-actions github-actions Bot added c: contributor-productivity Team-specific productivity, code health, technical debt. framework flutter/packages/flutter repository. See also f: labels. and removed CICD Run CI/CD labels May 7, 2026
@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label May 7, 2026
@keertip keertip mentioned this pull request May 7, 2026
Closed
bwilkerson
bwilkerson previously approved these changes May 8, 2026
View reviewed changes
Comment thread docs/contributing/Data-driven-Fixes.md Outdated
@github-actions github-actions Bot removed the CICD Run CI/CD label May 8, 2026
@keertip keertip requested a review from justinmc May 8, 2026 20:27
bwilkerson
bwilkerson previously approved these changes May 8, 2026
View reviewed changes
justinmc
justinmc previously approved these changes May 8, 2026
View reviewed changes

@justinmc justinmc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs LGTM based on my understanding, though I'm struggling to try it out locally. Probably my own lack of knowledge of dart fix is the problem.

  - title: 'Migrate from flutter/material.dart to material_ui/material_ui.dart.'
    date: 2026-05-08
    library: 'package:flutter/material.dart'
    changes:
      - kind: 'replacedBy'
        newLibrary: 'package:material_ui/material_ui.dart'

@keertip keertip enabled auto-merge May 8, 2026 21:17
@keertip

keertip commented May 8, 2026

Copy link
Copy Markdown
Contributor Author

Docs LGTM based on my understanding, though I'm struggling to try it out locally. Probably my own lack of knowledge of dart fix is the problem.

  - title: 'Migrate from flutter/material.dart to material_ui/material_ui.dart.'
    date: 2026-05-08
    library: 'package:flutter/material.dart'
    changes:
      - kind: 'replacedBy'
        newLibrary: 'package:material_ui/material_ui.dart'

Yes, this is looks right. You would add this to the fix_data.yaml in flutter package and it should get picked up by dart fix.

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label May 11, 2026
@justinmc

justinmc commented May 11, 2026

Copy link
Copy Markdown
Contributor

Looks like I'm still waiting for this change to roll into flutter/flutter before I can try it. The change didn't seem get into roll #186148 (closed) or roll #185992 (still open).

@keertip
Update Data-driven-Fixes.md
8f98aa0 
remove trailing whitespace
@keertip keertip dismissed stale reviews from justinmc and bwilkerson via 8f98aa0 May 11, 2026 18:37
@github-actions github-actions Bot removed the CICD Run CI/CD label May 11, 2026
@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label May 11, 2026
@github-actions github-actions Bot removed the CICD Run CI/CD label May 20, 2026
@Piinks Piinks requested a review from justinmc May 26, 2026 22:40
justinmc
justinmc approved these changes May 26, 2026
View reviewed changes

@justinmc justinmc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 . This has rolled and I was able to try it and confirm it works for my use case.

@keertip is there anything we should change about this given your recent changes? Looks correct to me.

@justinmc justinmc added the CICD Run CI/CD label May 26, 2026
@keertip keertip added this pull request to the merge queue May 26, 2026
Merged via the queue into flutter:master with commit 21f8100 May 26, 2026
18 of 19 checks passed
@keertip keertip deleted the data-driven-docs branch May 26, 2026 23:37
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request May 27, 2026
Merged
auto-submit Bot pushed a commit to flutter/packages that referenced this pull request May 27, 2026
@engine-flutter-autoroll
Roll Flutter from f3a4b9897834 to c8f2f166323e (29 revisions) (#11795)
4b424d7 
flutter/flutter@f3a4b98...c8f2f16

2026-05-27 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Flutter GPU] Add explicit draw counts (#186639)" (flutter/flutter#187170)
2026-05-27 engine-flutter-autoroll@skia.org Roll Dart SDK from 7dcea971af6b to f3db7b7d9801 (2 revisions) (flutter/flutter#187144)
2026-05-27 bdero@google.com [Flutter GPU] Add explicit draw counts (flutter/flutter#186639)
2026-05-27 engine-flutter-autoroll@skia.org Roll Skia from f9db7748563e to fa944af10f91 (1 revision) (flutter/flutter#187139)
2026-05-27 bdero@google.com [Flutter GPU] Flutter GPU ShaderLibrary in-place reload for shader hot reload (flutter/flutter#186793)
2026-05-27 engine-flutter-autoroll@skia.org Roll Skia from a692cbf38952 to f9db7748563e (8 revisions) (flutter/flutter#187135)
2026-05-27 burak.karahan@mail.ru Use local semantics tester in Material button tests (flutter/flutter#186667)
2026-05-27 rmolivares@renzo-olivares.dev Filter out `a: text input` from `team-framework` PR triage  (flutter/flutter#187129)
2026-05-27 bkonyi@google.com [Engine] Fix silent buffer mismatch bug in FML Win32 CommandLineFromPlatform (flutter/flutter#187120)
2026-05-27 srawlins@google.com examples: Remove unused parameters (flutter/flutter#185819)
2026-05-27 116356835+AbdeMohlbi@users.noreply.github.com Remove another `String.valueOf` (flutter/flutter#186628)
2026-05-27 alex.medinsh@gmail.com Print trace when skipping flavor-specific and platform-specific assets (flutter/flutter#187045)
2026-05-26 adilhanney@disroot.org Fix `InteractiveViewer` memory leak from undisposed `CurvedAnimation`s (flutter/flutter#185826)
2026-05-26 meylis@divine.video Fix AccessibilityBridge startup crash on vendor-modified Android (flutter/flutter#184630)
2026-05-26 keertip@users.noreply.github.com Update data driven fixes docs (flutter/flutter#186217)
2026-05-26 ahmedsameha1@gmail.com Add more 0x0 size tests part10 (flutter/flutter#186201)
2026-05-26 46920873+gabrimatic@users.noreply.github.com Disable spell check for obscured text (flutter/flutter#186329)
2026-05-26 chris@bracken.jp [iOS] Migrate VSyncClient and DisplayLinkManager to Swift (flutter/flutter#187001)
2026-05-26 bkonyi@google.com [flutter_tools, devicelab] Add safety filesystem guard to tests (flutter/flutter#186748)
2026-05-26 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from Itd2Jq_ZIABH2rW7B... to k9EizfEGJO4WwQN9-... (flutter/flutter#187115)
2026-05-26 engine-flutter-autoroll@skia.org Roll Dart SDK from 00e625453c43 to 7dcea971af6b (1 revision) (flutter/flutter#187117)
2026-05-26 rmacnak@google.com Remove use of deprecated copy_trees. (flutter/flutter#187091)
2026-05-26 15619084+vashworth@users.noreply.github.com Use resolved implementation plugins with SwiftPM (flutter/flutter#187097)
2026-05-26 engine-flutter-autoroll@skia.org Roll Skia from 27a819894f7c to a692cbf38952 (3 revisions) (flutter/flutter#187109)
2026-05-26 engine-flutter-autoroll@skia.org Roll Packages from 69cf959 to fc795e5 (4 revisions) (flutter/flutter#187114)
2026-05-26 mvincentong@gmail.com Handle simctl process exceptions during discovery (flutter/flutter#186501)
2026-05-26 mvincentong@gmail.com Clarify precache enabled platforms help (flutter/flutter#186878)
2026-05-26 bkonyi@google.com [tool] Refactor artifacts.dart to use enhanced enums and reduce duplication (flutter/flutter#187063)
2026-05-26 jason-simmons@users.noreply.github.com Build script updates for syncing engine sources and building artifacts on linux-arm64 (flutter/flutter#186917)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC boetger@google.com,stuartmorgan@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
@engine-flutter-autoroll
Roll Flutter from f3a4b9897834 to c8f2f166323e (29 revisions) (flutte…
565c597 
…r#11795)

flutter/flutter@f3a4b98...c8f2f16

2026-05-27 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Flutter GPU] Add explicit draw counts (#186639)" (flutter/flutter#187170)
2026-05-27 engine-flutter-autoroll@skia.org Roll Dart SDK from 7dcea971af6b to f3db7b7d9801 (2 revisions) (flutter/flutter#187144)
2026-05-27 bdero@google.com [Flutter GPU] Add explicit draw counts (flutter/flutter#186639)
2026-05-27 engine-flutter-autoroll@skia.org Roll Skia from f9db7748563e to fa944af10f91 (1 revision) (flutter/flutter#187139)
2026-05-27 bdero@google.com [Flutter GPU] Flutter GPU ShaderLibrary in-place reload for shader hot reload (flutter/flutter#186793)
2026-05-27 engine-flutter-autoroll@skia.org Roll Skia from a692cbf38952 to f9db7748563e (8 revisions) (flutter/flutter#187135)
2026-05-27 burak.karahan@mail.ru Use local semantics tester in Material button tests (flutter/flutter#186667)
2026-05-27 rmolivares@renzo-olivares.dev Filter out `a: text input` from `team-framework` PR triage  (flutter/flutter#187129)
2026-05-27 bkonyi@google.com [Engine] Fix silent buffer mismatch bug in FML Win32 CommandLineFromPlatform (flutter/flutter#187120)
2026-05-27 srawlins@google.com examples: Remove unused parameters (flutter/flutter#185819)
2026-05-27 116356835+AbdeMohlbi@users.noreply.github.com Remove another `String.valueOf` (flutter/flutter#186628)
2026-05-27 alex.medinsh@gmail.com Print trace when skipping flavor-specific and platform-specific assets (flutter/flutter#187045)
2026-05-26 adilhanney@disroot.org Fix `InteractiveViewer` memory leak from undisposed `CurvedAnimation`s (flutter/flutter#185826)
2026-05-26 meylis@divine.video Fix AccessibilityBridge startup crash on vendor-modified Android (flutter/flutter#184630)
2026-05-26 keertip@users.noreply.github.com Update data driven fixes docs (flutter/flutter#186217)
2026-05-26 ahmedsameha1@gmail.com Add more 0x0 size tests part10 (flutter/flutter#186201)
2026-05-26 46920873+gabrimatic@users.noreply.github.com Disable spell check for obscured text (flutter/flutter#186329)
2026-05-26 chris@bracken.jp [iOS] Migrate VSyncClient and DisplayLinkManager to Swift (flutter/flutter#187001)
2026-05-26 bkonyi@google.com [flutter_tools, devicelab] Add safety filesystem guard to tests (flutter/flutter#186748)
2026-05-26 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from Itd2Jq_ZIABH2rW7B... to k9EizfEGJO4WwQN9-... (flutter/flutter#187115)
2026-05-26 engine-flutter-autoroll@skia.org Roll Dart SDK from 00e625453c43 to 7dcea971af6b (1 revision) (flutter/flutter#187117)
2026-05-26 rmacnak@google.com Remove use of deprecated copy_trees. (flutter/flutter#187091)
2026-05-26 15619084+vashworth@users.noreply.github.com Use resolved implementation plugins with SwiftPM (flutter/flutter#187097)
2026-05-26 engine-flutter-autoroll@skia.org Roll Skia from 27a819894f7c to a692cbf38952 (3 revisions) (flutter/flutter#187109)
2026-05-26 engine-flutter-autoroll@skia.org Roll Packages from 69cf959 to fc795e5 (4 revisions) (flutter/flutter#187114)
2026-05-26 mvincentong@gmail.com Handle simctl process exceptions during discovery (flutter/flutter#186501)
2026-05-26 mvincentong@gmail.com Clarify precache enabled platforms help (flutter/flutter#186878)
2026-05-26 bkonyi@google.com [tool] Refactor artifacts.dart to use enhanced enums and reduce duplication (flutter/flutter#187063)
2026-05-26 jason-simmons@users.noreply.github.com Build script updates for syncing engine sources and building artifacts on linux-arm64 (flutter/flutter#186917)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC boetger@google.com,stuartmorgan@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
via-guy pushed a commit to via-guy/flutter that referenced this pull request Jun 26, 2026
@keertip @via-guy
Update data driven fixes docs (flutter#186217)
6d2b1b4 
Update the docs for data driven fixes with the addition of a new syntax
for replacing libraries.

The change has landed in the Dart SDK and should be in flutter soon -
dart-lang/sdk@18c1a3f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@justinmc justinmc justinmc approved these changes
@bwilkerson bwilkerson bwilkerson left review comments
+1 more reviewer
@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

c: contributor-productivity Team-specific productivity, code health, technical debt. CICD Run CI/CD d: docs/ flutter/flutter/docs, for contributors framework flutter/packages/flutter repository. See also f: labels. team-devexp Owned by the Developer Experience team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@keertip @justinmc @bwilkerson @alpesh76