[quick_actions] Adopt code-excerpts for README - #12643
auto-submit[bot] merged 11 commits into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
8ec30ab to
bf1351c
Compare
Replaces the hand-written Dart snippets in the README with <?code-excerpt?> pragmas backed by example/lib/readme_excerpts.dart, so they're validated against compilable, analyzed source instead of being free-hand text (one used an untyped callback parameter and print(), which isn't allowed by the repo's lint rules). Also drops the package's ci_config.yaml, whose only purpose was opting it out of that validation. Part of flutter/flutter#102679. FPOCTSMP-10
bf1351c to
729590c
Compare
There was a problem hiding this comment.
Code Review
This pull request integrates code-excerpt into the quick_actions package README to validate Dart snippets against compilable source code. It adds a new readme_excerpts.dart file containing the code snippets, updates the README to reference these excerpts, removes the exempt_from_excerpts flag, and bumps the package version to 1.1.1. There are no review comments to address.
stuartmorgan-g
left a comment
There was a problem hiding this comment.
LGTM
Unlike the other PR where I commented about tests, we can't actually call this code from unit tests without stubbing out so much that it's not actually doing anything useful, so no need to uni test these. Ideally given that, we would instead use actually code from the example app instead of from a dummy excerpts file, but unifying this with the example app without needing a bunch of integration test changes is more trouble than it's worth.
…er#192485) flutter/packages@9af9c60...36e088a 2026-09-09 daniel.leon@cloudsufi.com [quick_actions] Adopt code-excerpts for README (flutter/packages#12643) 2026-09-08 65155920+0xharkirat@users.noreply.github.com [camera_web] Fix TypeError when reading the torch capability (flutter/packages#12647) 2026-09-08 gibbonsj97@gmail.com [google_maps_flutter_web] Avoid replacing advanced marker content on move (flutter/packages#11952) 2026-09-08 mit@google.com [material_ui][cupertino_ui] Change issue tracker label in pubspec.yaml (flutter/packages#12792) 2026-09-08 saurabhmirajkar000@gmail.com [material_ui] Fix FilledButton Material 3 default style docs (flutter/packages#12620) 2026-09-08 21270878+elliette@users.noreply.github.com [infra] Use a modified no-response workflow in flutter/packages (flutter/packages#12745) 2026-09-08 21270878+elliette@users.noreply.github.com [material_ui] Migrate M3 Banner template to use new gen_defaults (flutter/packages#12734) 2026-09-08 engine-flutter-autoroll@skia.org Roll Flutter from 63170e9 to b444e78 (13 revisions) (flutter/packages#12791) 2026-09-08 fluttergithubbot@gmail.com Sync release-go_router-18.0.1 to main (flutter/packages#12725) 2026-09-08 fluttergithubbot@gmail.com Sync release-material_ui-1.1.1 to main (flutter/packages#12726) 2026-09-08 stuartmorgan@google.com [tool] Adopt `platform` 3.2.0 (flutter/packages#12789) 2026-09-07 50643541+Mairramer@users.noreply.github.com [material_ui] Fix SliverGeometry maxPaintExtent assertion in CarouselView.weighted (flutter/packages#12563) 2026-09-05 engine-flutter-autoroll@skia.org Roll Flutter from 5a6cfa7 to 63170e9 (15 revisions) (flutter/packages#12767) 2026-09-04 engine-flutter-autoroll@skia.org Manual roll Flutter from 70797e1 to 5a6cfa7 (52 revisions) (flutter/packages#12760) 2026-09-04 brackenavaron@gmail.com [material_ui] port drawer tests over from flutter/widgets (flutter/packages#12711) 2026-09-04 tarrinneal@gmail.com add cooldown (flutter/packages#12708) 2026-09-04 joeldumasbg@gmail.com [in_app_purchase] Support StoreKit 2 introductory offer eligibility JWS (flutter/packages#12584) 2026-09-04 21270878+elliette@users.noreply.github.com [material_ui] Migrate M3 Badge template to use new gen_defaults (flutter/packages#12733) 2026-09-04 stuartmorgan@google.com [google_maps_flutter] Convert heatmap controller to Swift (flutter/packages#12713) 2026-09-04 97480502+b-luk@users.noreply.github.com [material_ui] Remove unused `maintainState` constructor parameter in `scaffold_test.dart` (flutter/packages#12754) 2026-09-04 a1rwulf@users.noreply.github.com [video_player_avfoundation] Route video over AirPlay (flutter/packages#12490) 2026-09-04 jerome.dellamaria@proton.me [google_fonts] Add google_fonts_lite file to allow tree-shaking of the other huge files (flutter/packages#11433) 2026-09-04 engine-flutter-autoroll@skia.org Roll Flutter from 0cbd1a4 to 70797e1 (27 revisions) (flutter/packages#12727) 2026-09-04 stuartmorgan@google.com Update Chrome for stable tests (flutter/packages#12747) If this roll has caused a breakage, revert this CL and set the roller to dry run mode using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: 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
Replaces the hand-written Dart snippets in `quick_actions`'s README with `<?code-excerpt?>` pragmas backed by `example/lib/readme_excerpts.dart`, so they're validated against compilable, analyzed source instead of free-hand text (the original used an untyped callback parameter and `print()`, which the repo's lint rules disallow). Also drops the package's `ci_config.yaml`, whose only purpose was opting it out of that validation. Follows the same pattern as flutter#12641 ([pointer_interceptor] Adopt code-excerpts for README). Part of #102679. ## Pre-Review Checklist ## Test plan [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. **Note**: The Flutter team is currently trialing [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from `gemini-code-assist[bot]` aren't authoritative Flutter-team feedback; I'll wait for a human reviewer's guidance on which automated comments (if any) should be addressed.
Replaces the hand-written Dart snippets in `quick_actions`'s README with `<?code-excerpt?>` pragmas backed by `example/lib/readme_excerpts.dart`, so they're validated against compilable, analyzed source instead of free-hand text (the original used an untyped callback parameter and `print()`, which the repo's lint rules disallow). Also drops the package's `ci_config.yaml`, whose only purpose was opting it out of that validation. Follows the same pattern as flutter#12641 ([pointer_interceptor] Adopt code-excerpts for README). Part of #102679. ## Pre-Review Checklist ## Test plan [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. **Note**: The Flutter team is currently trialing [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from `gemini-code-assist[bot]` aren't authoritative Flutter-team feedback; I'll wait for a human reviewer's guidance on which automated comments (if any) should be addressed.
The excerpt validator (`readme_validator.dart`) only requires `<?code-excerpt?>` management for **Dart** code blocks, so the README's Java/Groovy/XML/sh snippets are left untouched. The one Dart block — the `test_driver/` script — used the deprecated `flutter_driver` `enableFlutterDriverExtension()` API, which no longer has a real, compilable counterpart in this repo now that the example app migrated to the `integration_test` package. Points the excerpt at the example's actual `test_driver/integration_test.dart` (`integrationDriver()`) instead, and updates the surrounding prose and the `./gradlew` command to match the real filename. Also drops the package's `ci_config.yaml`, whose only purpose was opting it out of that validation. Follows the same pattern as #12641 ([pointer_interceptor] Adopt code-excerpts for README) and #12643 ([quick_actions] Adopt code-excerpts for README). Part of flutter/flutter#102679. ## Pre-Review Checklist ## Test plan [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. **Note**: The Flutter team is currently trialing [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from `gemini-code-assist[bot]` aren't authoritative Flutter-team feedback; I'll wait for a human reviewer's guidance on which automated comments (if any) should be addressed.
Replaces the hand-written Dart snippets in
quick_actions's README with<?code-excerpt?>pragmas backed byexample/lib/readme_excerpts.dart, so they're validated against compilable, analyzed source instead of free-hand text (the original used an untyped callback parameter andprint(), which the repo's lint rules disallow). Also drops the package'sci_config.yaml, whose only purpose was opting it out of that validation.Follows the same pattern as #12641 ([pointer_interceptor] Adopt code-excerpts for README).
Part of #102679.
Pre-Review Checklist
[shared_preferences]1.1.1).///). — not applicable, no public API surface changed.readme_excerpts.dartis validated bydart analyze/dart formatand theupdate-excerptscheck itself; no runtime behavior changed.Test plan
dart run script/tool/bin/flutter_plugin_tools.dart update-excerpts --packages=quick_actions— no diff after regenerationdart run script/tool/bin/flutter_plugin_tools.dart validate --packages=quick_actions— no issuesflutter analyzeinexample/— no issuesdart format --output=none --set-exit-if-changedon the new excerpts file — no changes neededflutter testin the package — all tests passNote: The Flutter team is currently trialing Gemini Code Assist for GitHub. Comments from
gemini-code-assist[bot]aren't authoritative Flutter-team feedback; I'll wait for a human reviewer's guidance on which automated comments (if any) should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩