Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Apr 19, 2023

Conversation

tarrinneal
Copy link
Contributor

@tarrinneal tarrinneal commented Apr 18, 2023

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
Copy link

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
Copy link
Contributor Author

@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.

@tarrinneal tarrinneal changed the title [Tool] Excerpt example readme [Tool] [Code Excerpt] allow excerpts in example readme Apr 18, 2023
script/tool/CHANGELOG.md Show resolved Hide resolved
script/tool/lib/src/update_excerpts_command.dart Outdated Show resolved Hide resolved
@stuartmorgan
Copy link
Contributor

@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.

@tarrinneal tarrinneal requested a review from stuartmorgan April 19, 2023 05:06
Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

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

LGTM!

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 19, 2023
@auto-submit auto-submit bot merged commit 84ebba2 into flutter:main Apr 19, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 20, 2023
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Apr 20, 2023
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
pro100andrey added a commit to pro100andrey/packages that referenced this pull request Apr 25, 2023
* main: (144 commits)
  Update test golden images for the latest Skia roll (flutter#3787)
  [various] Adds Android namespace (flutter#3791)
  [shared_preferences] Update gradle/agp in example apps (flutter#3809)
  [go_router] Adds name to TypedGoRoute (flutter#3702)
  [webview_flutter] Adds support to receive permission requests (flutter#3543)
  [google_sign_in] Fix Android Java warnings (flutter#3762)
  [local_auth] Fix enum return on Android (flutter#3780)
  [pigeon] Warn when trying to use enums in collections (flutter#3782)
  [webview_flutter_android] [webview_flutter_wkwebview] Platform implementations for supporting permission requests (flutter#3792)
  [pigeon] Update for compatibility with a future change to the analyzer. (flutter#3789)
  [camera_android] Fix Android lint warnings  (flutter#3716)
  [webview_flutter_platform_interface] Adds method to receive permission requests (flutter#3767)
  [image_picker_ios] In unit test write and read kCGImagePropertyExifUserComment property (flutter#3783)
  [go_router_builder] Fixed the return value of the generated push method (flutter#3650)
  [image_picker] Mention `launchMode: singleInstance` in README (flutter#3759)
  Revert "[pigeon] Add an initial example app" (flutter#3785)
  [google_maps_flutter] Add examples for different iOS versions (flutter#3757)
  [pigeon] Add an initial example app (flutter#3761)
  [google_maps_flutter_web] Allow marker position updates (flutter#3697)
  [Tool] [Code Excerpt] allow excerpts in example readme (flutter#3758)
  ...

# Conflicts:
#	packages/camera/camera/pubspec.yaml
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
Adds the ability to add code excerpts to README files within the example directory.
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants