Skip to content

[tool] Support code excerpts for any .md file #4212

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 15, 2023
Merged

[tool] Support code excerpts for any .md file #4212

merged 2 commits into from
Jun 15, 2023

Conversation

stuartmorgan-g
Copy link
Contributor

Updates update-excerpts to support any top-level .md file (other than CHANGELOG.md), rather than just README.md. This is useful for supplemental content, such as migration guides linked from the main README file.

Also makes some small improvements to the error messaging:

  • The list of incorrect files is now relative to, and restricted to, the package. This makes the error message simpler, and ensures that changed files in other packages don't get listed.
  • Adds a link to the relevant wiki docs, since this has been a source of confusion for newer contributors.

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.

@stuartmorgan-g
[tool] Support code excerpts for any .md file
8ec486b 
Updates `update-excerpts` to support any top-level .md file (other than
CHANGELOG.md), rather than just README.md. This is useful for
supplemental content, such as migration guides linked from the main
README file.

Also makes some small improvements to the error messaging:
- The list of incorrect files is now relative to, and restricted to, the
  package. This makes the error message simpler, and ensures that
  changed files in other packages don't get listed.
- Adds a link to the relevant wiki docs, since this has been a source of
  confusion for newer contributors.
@stuartmorgan-g stuartmorgan-g mentioned this pull request Jun 14, 2023
Merged
11 tasks
tarrinneal
tarrinneal approved these changes Jun 14, 2023
View reviewed changes
Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

optional nit

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 15, 2023
@auto-submit auto-submit bot merged commit fa2e8a0 into flutter:main Jun 15, 2023
@stuartmorgan-g stuartmorgan-g deleted the tool-excerpt-any-md branch June 15, 2023 14:35
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 16, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 16, 2023
@engine-flutter-autoroll
fa2e8a0 [tool] Support code excerpts for any .md file (flutter/packag…
e84c24d 
…es#4212)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Jun 16, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jun 16, 2023
@engine-flutter-autoroll
fa2e8a0 [tool] Support code excerpts for any .md file (flutter/packag…
9bdb1f9 
…es#4212)
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Jun 16, 2023
@engine-flutter-autoroll
Roll Packages from f9314a3 to 59d93d6 (18 revisions) (#129021)
3f73d2c 
flutter/packages@f9314a3...59d93d6

2023-06-16 stuartmorgan@google.com [tool] Add command aliases (flutter/packages#4207)
2023-06-16 stuartmorgan@google.com [google_map_flutter] Fix map object regression due to async changes (flutter/packages#4171)
2023-06-16 goderbauer@google.com [url_launcher] Add ignores for deprecated member to test (flutter/packages#4220)
2023-06-15 engine-flutter-autoroll@skia.org Roll Flutter from 95be76a to b0188cd (10 revisions) (flutter/packages#4221)
2023-06-15 34871572+gmackall@users.noreply.github.com [camera_android] Upgrading roboelectric from 4.5 to 4.10.3 (flutter/packages#4018)
2023-06-15 47866232+chunhtai@users.noreply.github.com [go_router] Fixes bug that GoRouterState in top level redirect doesn'� (flutter/packages#4173)
2023-06-15 47866232+chunhtai@users.noreply.github.com [go_router]Updates documentations around GoRouter.of, GoRouter.maybeOf, and BuildContext extension. (flutter/packages#4176)
2023-06-15 stuartmorgan@google.com [tool] Support code excerpts for any .md file (flutter/packages#4212)
2023-06-15 baptiste.dupuch@gmail.com [webview_flutter] Add support for limitsNavigationsToAppBoundDomains (flutter/packages#4026)
2023-06-15 yk3372@gmail.com [webview_flutter][webview_flutter_android] Add android support for handling geolocation permissions (flutter/packages#3795)
2023-06-15 tarrinneal@gmail.com [image_picker] add getMedia method (flutter/packages#3892)
2023-06-15 tarrinneal@gmail.com [image_picker] getMedia platform implementations (flutter/packages#4175)
2023-06-14 31859944+LongCatIsLooong@users.noreply.github.com Ignore `textScaleFactor` deprecation (flutter/packages#4209)
2023-06-14 stuartmorgan@google.com [pigeon] Enable Obj-C integration tests in CI (flutter/packages#4215)
2023-06-14 63286031+ahmednfwela@users.noreply.github.com [flutter_adaptive_scaffold] Support RTL (flutter/packages#4204)
2023-06-14 engine-flutter-autoroll@skia.org Manual roll Flutter from 09b7e56 to 95be76a (14 revisions) (flutter/packages#4214)
2023-06-14 engine-flutter-autoroll@skia.org Roll Flutter (stable) from 682aa38 to 796c8ef (5 revisions) (flutter/packages#4213)
2023-06-14 engine-flutter-autoroll@skia.org Roll Flutter from 353b8bc to 09b7e56 (17 revisions) (flutter/packages#4206)

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
This was referenced Jul 7, 2023
Merged
Closed
Merged
@reidbaker reidbaker mentioned this pull request Jul 26, 2023
Merged
11 tasks
@reidbaker reidbaker mentioned this pull request Aug 4, 2023
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tarrinneal tarrinneal tarrinneal approved these changes

@bparrishMines bparrishMines Awaiting requested review from bparrishMines

Assignees
No one assigned
Labels
autosubmit Merge 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
@stuartmorgan-g @tarrinneal