Skip to content

[espresso] Adopt code-excerpts for README - #12644

Merged
auto-submit[bot] merged 15 commits into
flutter:mainfrom
victogomez-cs:fpoctsmp-5-espresso-readme-excerpts
Sep 15, 2026
Merged

auto-submit[bot] merged 15 commits into
flutter:mainfrom
victogomez-cs:fpoctsmp-5-espresso-readme-excerpts

Conversation

@danielleon-cmd

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

Copy link
Copy Markdown
Contributor

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

  • 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 0.4.0+26).
  • 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 updated test_driver/integration_test.dart docregion 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=espresso — no diff after regeneration
  • dart run script/tool/bin/flutter_plugin_tools.dart validate --packages=espresso — no issues
  • flutter analyze in example/ — no issues
  • dart format --output=none --set-exit-if-changed on the updated driver file — no changes needed
  • No Dart unit tests exist for this package (native-only bindings), so none to run

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-5-espresso-readme-excerpts branch from f6608a0 to 09d6734 Compare August 27, 2026 15:56
The excerpt validator only requires code-excerpt management for Dart
code blocks, so the README's Java/Groovy/XML/sh snippets are 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 gradle command to match.
Also drops the package's ci_config.yaml, whose only purpose was opting
it out of that validation.

Part of flutter/flutter#102679.

FPOCTSMP-5
Same issue flagged on #32/#34: these README changes need to be
published, so they can't stay under `## NEXT`.

FPOCTSMP-5
@danielleon-cmd
danielleon-cmd force-pushed the fpoctsmp-5-espresso-readme-excerpts branch from 66ab473 to 36c41c5 Compare August 27, 2026 16:09
@danielleon-cmd danielleon-cmd added the CICD Run CI/CD label Sep 3, 2026
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 3, 2026
@danielleon-cmd danielleon-cmd self-assigned this Sep 7, 2026
@danielleon-cmd danielleon-cmd added the CICD Run CI/CD label Sep 7, 2026
@flutter-dashboard flutter-dashboard Bot removed the CICD Run CI/CD label Sep 8, 2026
@danielleon-cmd
danielleon-cmd marked this pull request as ready for review September 8, 2026 23:33

@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 'espresso' package to adopt 'code-excerpt' for the README's Dart driver snippet, ensuring it is validated against compilable source code. Additionally, the documentation and example are updated to use the 'integration_test' package driver instead of the deprecated 'flutter_driver' extension. Review feedback suggests using '$(pwd)' instead of backticks for command substitution in the README's command line example to improve readability and shell compatibility.

Comment thread packages/espresso/README.md

@stuartmorgan-g stuartmorgan-g left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

It's only currently required for Dart, but it supports lots of languages, and we should adopt it proactively for them where we can reasonably do so. I don't think we have a good source for the Java block right now so it's fine to defer that, but the XML should be extractable directly from existing files in the example app, and the groovy section should be updated to instead discuss build.gradle.kts (the file that any recently-created Flutter app will have) and pull from the example app so that it's showing current versions instead of old versions (the example app's dependencies section can be re-ordered to make it one block, or you can use disjoint blocks and have some ...s in the result).

The current changes look good, but we should get the low-hanging fruit of adding the other easy excerpts while this work is happening.

…ppets

Adds code-excerpt management for the network_security_config.xml
snippet and switches the dependencies snippet from Groovy to
build.gradle.kts, pulling current versions from the example app.
@danielleon-cmd

Copy link
Copy Markdown
Contributor Author

Addressed the low-hanging fruit from the review in 2093d3f:

...the XML should be extractable directly from existing files in the example app, and the groovy section should be updated to instead discuss build.gradle.kts (the file that any recently-created Flutter app will have) and pull from the example app so that it's showing current versions instead of old versions (the example app's dependencies section can be re-ordered to make it one block, or you can use disjoint blocks and have some ...s in the result).

  • network_security_config.xml is now code-excerpt-managed, pulled directly from example/android/app/src/debug/res/xml/network_security_config.xml.
  • The dependencies snippet now targets build.gradle.kts (was stale build.gradle/Groovy) and is code-excerpt-managed via disjoint doc-regions with ··· placeholders, so it reflects the example app's current dependency versions instead of drifting.

I don't think we have a good source for the Java block right now so it's fine to defer that

Left the Java MainActivityTest.java block as-is per that note.

Verified with update-excerpts and validate — no diffs, no issues.

@stuartmorgan-g stuartmorgan-g added the CICD Run CI/CD label Sep 15, 2026

@stuartmorgan-g stuartmorgan-g left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@danielleon-cmd danielleon-cmd added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 15, 2026
@auto-submit
auto-submit Bot merged commit 6171e00 into flutter:main Sep 15, 2026
14 checks passed
GhagSagar23 pushed a commit to Kryonex-Labs/flutter that referenced this pull request Sep 16, 2026
…r#192876)

flutter/packages@bebbb57...c2b58e1

2026-09-15 stuartmorgan@google.com [local_auth] Convert implementation
to Kotlin (flutter/packages#12635)
2026-09-15 mhmmd.bayraktar@gmail.com [pigeon] Treat NSNull as null for
non-null Flutter API returns (flutter/packages#12531)
2026-09-15 daniel.leon@cloudsufi.com [espresso] Adopt code-excerpts for
README (flutter/packages#12644)
2026-09-15 daniel.leon@cloudsufi.com [pointer_interceptor] Adopt
code-excerpts for README (flutter/packages#12641)
2026-09-15 47866232+chunhtai@users.noreply.github.com [ci] Checks
unmerged batch release sync back before next release
(flutter/packages#12868)
2026-09-15 puneetkukreja98@gmail.com [material_ui] Add sortIconBuilder
to DataTable, PaginatedDataTable, and DataTableThemeData
(flutter/packages#12645)
2026-09-15 10687576+bparrishMines@users.noreply.github.com
[cross_file_platform_interface] Platform interface implementation of
`cross_file` (flutter/packages#12825)
2026-09-15 10687576+bparrishMines@users.noreply.github.com [cross_file]
Move cross_file into a federated cross_file directory
(flutter/packages#12869)

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App CICD Run CI/CD p: espresso platform-android

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants