Skip to content

[quick_actions] Adopt code-excerpts for README - #12643

Draft
danielleon-cmd wants to merge 5 commits into
flutter:mainfrom
victogomez-cs:fpoctsmp-10-quick-actions-readme-excerpts
Draft

[quick_actions] Adopt code-excerpts for README#12643
danielleon-cmd wants to merge 5 commits into
flutter:mainfrom
victogomez-cs:fpoctsmp-10-quick-actions-readme-excerpts

Conversation

@danielleon-cmd

@danielleon-cmd danielleon-cmd commented Aug 27, 2026

Copy link
Copy Markdown

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 #12641 ([pointer_interceptor] Adopt code-excerpts for README).

Part of #102679.

Pre-Review 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 page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter.
  • I signed the CLA. — pending; the CLA bot flagged this as a first-time contribution from this account.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I linked to at least one issue that this PR fixes in the description above.
  • I followed the version and CHANGELOG instructions, using semantic versioning and the repository CHANGELOG style (bumped to 1.1.1).
  • I updated/added any relevant documentation (doc comments with ///). — not applicable, no public API surface changed.
  • I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under1. — documentation-only change: the new readme_excerpts.dart is validated by dart analyze/dart format and the update-excerpts check itself; no runtime behavior changed.
  • All existing and new tests are passing.

Test plan

  • dart run script/tool/bin/flutter_plugin_tools.dart update-excerpts --packages=quick_actions — no diff after regeneration
  • dart run script/tool/bin/flutter_plugin_tools.dart validate --packages=quick_actions — no issues
  • flutter analyze in example/ — no issues
  • dart format --output=none --set-exit-if-changed on the new excerpts file — no changes needed
  • flutter test in the package — all tests pass

Note: 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

  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.

@google-cla

google-cla Bot commented Aug 27, 2026

Copy link
Copy Markdown

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.

@danielleon-cmd
danielleon-cmd force-pushed the fpoctsmp-10-quick-actions-readme-excerpts branch from 8ec30ab to bf1351c Compare August 27, 2026 15:55
@github-actions github-actions Bot added p: cross_file p: go_router triage-framework Should be looked at in framework triage p: cupertino_ui p: material_ui triage-design Should be looked at in design triage labels Aug 27, 2026
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
Since these README changes will be published, they can't stay under
`## NEXT` (same issue as #32/#34's review). Converts NEXT to a real
version, with the new excerpt bullet first and the pre-existing NEXT
items below it.

FPOCTSMP-10
@danielleon-cmd
danielleon-cmd force-pushed the fpoctsmp-10-quick-actions-readme-excerpts branch from bf1351c to 729590c Compare August 27, 2026 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant