Move `examples/api` to `packages/flutter/examples/api` and fix CI errors by dkwingsmt · Pull Request #190481 · flutter/flutter

dkwingsmt · 2026-08-03T22:38:50Z

This PR moves API examples from <root>/examples/api to <root>/packages/flutter/examples/api.

This change is required because the standard dartdoc directive {@example} requires API examples to reside within the package directory. For more details, see issue #189629 (item 1 under "What's needed").

Summary of changes

Moved all API example files to packages/flutter/examples/api.

Updated related scripts and CI configurations to reflect the new directory structure.

Most changes involve simple path updates from examples/api to packages/flutter/examples/api.
Some adjustments were more complex because the examples, which previously resided in a single <root>/examples directory, are now split across two separate locations.

Existing paths in "See code in " directives are retained. These paths are now treated as relative to the package root rather than the repository root. For example, the following API doc comment remains valid despite the file move:

  /// Class definition.
  ///
  /// {@tool sample}
  /// An example.
  ///
  /// ** See code in examples/api/lib/widgets/foo/foo.0.dart **
  /// {@end-tool}

Three API doc tests are now marked as reduced-test-set because they're now facing additional analysis for being under packages/flutter.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

gemini-code-assist

Code Review

This pull request relocates the examples/api directory to packages/flutter/examples/api and updates all associated CI configurations, labelers, analysis scripts, tests, and documentation to reflect this new path. The review feedback points out several incorrect path prefixes and relative paths introduced in .github/labeler.yml and dev/bots/analyze_snippet_code.dart that require correction.

dkwingsmt · 2026-08-04T22:11:07Z

/gemini review

gemini-code-assist

Code Review

This pull request relocates the API examples from the root examples/api directory to packages/flutter/examples/api, updating various CI configurations, analyzer scripts, and tests to reflect the new path. The review feedback highlights potential Windows-specific path issues in check_code_samples.dart and its tests, where backslashes in paths on Windows could cause prefix matching and string comparison failures. Code suggestions are provided to normalize path separators to forward slashes.

dkwingsmt · 2026-08-04T22:49:48Z

/gemini review

gemini-code-assist

Code Review

This pull request relocates the API examples from examples/api to packages/flutter/examples/api and updates the CI targets, labeler configuration, analysis scripts, snippet tools, and tests to use the new path. Feedback on the changes suggests skipping all File entities early in the cross-import checker loop to prevent type errors with non-Dart files, and normalizing paths to use forward slashes in the code sample tests to simplify the logic.

dkwingsmt · 2026-08-04T23:27:38Z

/gemini review

gemini-code-assist

Code Review

This pull request relocates the API examples directory from examples/api to packages/flutter/examples/api and updates associated CI configurations, analysis tools, tests, and documentation to reflect the new path. Feedback suggests checking if the API documentation directory exists before adding it to the list of example files to prevent potential runtime exceptions.

navaronbracke

LGTM, assuming the added reduced test set tags in the handful of tests are intentional.

Also, note for reviewers, Github does not seem to like the sheer size of the diff (even if 99% is moves/renames). The Github UI gets a little janky

navaronbracke · 2026-08-05T07:18:51Z

Dashboard checks hit an infra failure it seems. And this'll also need an override label for the code freeze I suppose

justinmc

LGTM 👍

jtmcdole

The LGTM exchange rates are currently trading at:

1 LGTM = golden images match closely enough if I squint.
2 LGTMs = I checked that this won't break the devicelab benchmarks
3 LGTMs = I trust that this C++ pointer won't leak memory every frame.
4 LGTMs = CI is green on the first try without a single retry or shard failure

… whitelist (flutter#191025) In flutter#190481, the API docs were moved from `<repo_root>/examples/api` to `<repo_root>/packages/flutter/examples/api`. `flutter create` is typically forbidden within Flutter's repo except for a few whitelisted directories. With the aforementioned migration, the whitelist should include the new API doc package as well. ## Pre-launch Checklist - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [ ] I signed the [CLA]. - [ ] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [ ] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

Upstream master moved examples/api to packages/flutter/examples/api (flutter#190481) while this PR was open. Merging master in left this PR's two new files (added after that move, so not covered by its rename detection) stranded at the old, now-unused examples/api path. Move them to match every other example under the flutter_api_samples package. The `** See code in examples/api/... **` doc references in container.dart are unchanged: they're resolved relative to the package root, which is exactly what moved.

flutter-dashboard Bot added the CICD Run CI/CD label Aug 3, 2026

gemini-code-assist Bot reviewed Aug 3, 2026

View reviewed changes

Comment thread .github/labeler.yml Outdated

Comment thread .github/labeler.yml Outdated

Comment thread dev/bots/analyze_snippet_code.dart Outdated

gemini-code-assist Bot reviewed Aug 4, 2026

View reviewed changes

Comment thread dev/bots/check_code_samples.dart Outdated

Comment thread dev/bots/test/check_code_samples_test.dart Outdated

gemini-code-assist Bot reviewed Aug 4, 2026

View reviewed changes

Comment thread dev/bots/check_examples_cross_imports.dart

Comment thread dev/bots/test/check_code_samples_test.dart Outdated

gemini-code-assist Bot reviewed Aug 4, 2026

View reviewed changes

Comment thread dev/bots/check_examples_cross_imports.dart

dkwingsmt requested review from Piinks, gaaclarke, jtmcdole, justinmc and navaronbracke August 4, 2026 23:39

navaronbracke previously approved these changes Aug 5, 2026

View reviewed changes

dkwingsmt added 2 commits August 5, 2026 09:55

Real changes

2a5487e

Move API doc files

cb1d9eb

dkwingsmt dismissed navaronbracke’s stale review via cb1d9eb August 5, 2026 16:57

dkwingsmt requested review from Piinks and justinmc August 7, 2026 02:52

Merge branch 'master' into move-examples-to-flutter

0e18ba0

justinmc previously approved these changes Aug 7, 2026

View reviewed changes

dkwingsmt added override code freeze Override an active code freeze. autosubmit Merge PR when tree becomes green via auto submit App labels Aug 7, 2026

auto-submit Bot added this pull request to the merge queue Aug 7, 2026

github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Aug 7, 2026

flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 7, 2026

Merge branch 'master' into move-examples-to-flutter

b95196c

dkwingsmt dismissed justinmc’s stale review via b95196c August 7, 2026 18:25

dkwingsmt requested a review from justinmc August 7, 2026 18:25

jtmcdole approved these changes Aug 7, 2026

View reviewed changes

jtmcdole added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 7, 2026

auto-submit Bot added this pull request to the merge queue Aug 7, 2026

Merged via the queue into flutter:master with commit 0feeeab Aug 7, 2026
22 checks passed

flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 7, 2026

dkwingsmt mentioned this pull request Aug 12, 2026

[flutter_tools] Add packages/flutter/examples to flutter create's whitelist #191025

Merged

10 tasks

dkwingsmt mentioned this pull request Aug 24, 2026

[material_ui, cupertino_ui] Recover certain macros that were migrated to avoid @tool leakage #189629

Open

8 tasks

Conversation

dkwingsmt commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Pre-launch Checklist

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dkwingsmt commented Aug 4, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

dkwingsmt commented Aug 4, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

dkwingsmt commented Aug 4, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

navaronbracke left a comment

Choose a reason for hiding this comment

Uh oh!

navaronbracke commented Aug 5, 2026

Uh oh!

justinmc left a comment

Choose a reason for hiding this comment

Uh oh!

jtmcdole left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dkwingsmt commented Aug 3, 2026 •

edited

Loading