Skip to content

[Tool] [Code Excerpt] allow excerpts in example readme - #3758

Merged
auto-submit[bot] merged 5 commits into
flutter:mainfrom
tarrinneal:excerpt-example-readme
Apr 19, 2023
Merged

[Tool] [Code Excerpt] allow excerpts in example readme#3758
auto-submit[bot] merged 5 commits into
flutter:mainfrom
tarrinneal:excerpt-example-readme

Conversation

@tarrinneal

@tarrinnealtarrinneal commented Apr 18, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Adds the ability to add code excerpts to README files within the example directory.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • 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.
  • All existing and new tests are passing.

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

@flutter-dashboard

flutter-dashboardBot commented Apr 18, 2023

Copy link
Copy Markdown

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@tarrinneal

tarrinneal commented Apr 18, 2023

Copy link
Copy Markdown
ContributorAuthor

@stuartmorgan curious what you think about tests with this.

The output that I see in the running tests doesn't include any of the Running command lines in the actual use output. Which I would need to show that it's running on both files.

@tarrinnealtarrinneal changed the title [Tool] Excerpt example readme[Tool] [Code Excerpt] allow excerpts in example readmeApr 18, 2023
stuartmorgan-g
stuartmorgan-g requested changes Apr 19, 2023
View reviewed changes
Comment threadscript/tool/CHANGELOG.md
Comment threadscript/tool/lib/src/update_excerpts_command.dart
Comment threadscript/tool/lib/src/update_excerpts_command.dart Outdated
@stuartmorgan-g

stuartmorgan-g commented Apr 19, 2023

Copy link
Copy Markdown
Collaborator

@stuartmorgan curious what you think about tests with this.

The output that I see in the running tests doesn't include any of the Running command lines in the actual use output. Which I would need to show that it's running on both files.

Oops, missed this comment, sorry. The test that it's running for both would be via processes, like this one but with a second expected run with a different path.

stuartmorgan-g
stuartmorgan-g reviewed Apr 19, 2023
View reviewed changes
Comment threadscript/tool/test/update_excerpts_command_test.dart
stuartmorgan-g
stuartmorgan-g approved these changes Apr 19, 2023
View reviewed changes

@stuartmorgan-gstuartmorgan-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!

@tarrinnealtarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 19, 2023
@auto-submit
auto-submitBot merged commit 84ebba2 into flutter:mainApr 19, 2023
@engine-flutter-autorollengine-flutter-autoroll mentioned this pull request Apr 20, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 20, 2023
@engine-flutter-autoroll
84ebba2[Tool] [Code Excerpt] allow excerpts in example readme (flutt…
e810ca9
…er/packages#3758)
auto-submitBot pushed a commit to flutter/flutter that referenced this pull request Apr 20, 2023
@engine-flutter-autoroll
Roll Packages from88591beto746750e(4 revisions) (#125208)
70ca469
flutter/packages@88591be...746750e
2023-04-20 stuartmorgan@google.com [pigeon] Add an initial example app (flutter/packages#3761)
2023-04-20 imagipioneer@gmail.com [google_maps_flutter_web] Allow marker position updates (flutter/packages#3697)
2023-04-19 tarrinneal@gmail.com [Tool] [Code Excerpt] allow excerpts in example readme (flutter/packages#3758)
2023-04-19 47866232+chunhtai@users.noreply.github.com [go_router] migrates test for route information.location deprecation (flutter/packages#3763)
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-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
@reidbakerreidbaker mentioned this pull request Apr 25, 2023
Merged
11 tasks
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
@tarrinneal@nploi
[Tool] [Code Excerpt] allow excerpts in example readme (flutter#3758)
91c1c8f
Adds the ability to add code excerpts to README files within the example directory.
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
@tarrinneal
[Tool] [Code Excerpt] allow excerpts in example readme (flutter#3758)
da8c681
Adds the ability to add code excerpts to README files within the example directory.
bisor0627 pushed a commit to bisor0627/packages that referenced this pull request Jun 19, 2026
@tarrinneal
[Tool] [Code Excerpt] allow excerpts in example readme (flutter#3758)
ef19c86
Adds the ability to add code excerpts to README files within the example directory.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stuartmorgan-gstuartmorgan-gstuartmorgan-g approved these changes

Assignees

No one assigned

Labels

autosubmitMerge PR when tree becomes green via auto submit App

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tarrinneal@stuartmorgan-g