This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[flutter_plugin_tools] Adds update-excerpts command #5339
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@csells FYI 🙂 |
Nice!! |
stuartmorgan
changed the title
[flutter_plugin_tools] Adds update-snippets command
[flutter_plugin_tools] Adds update-excerpts command
Apr 26, 2022
25 tasks
bparrishMines
approved these changes
Apr 27, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a couple nits and suggestions
stuartmorgan
added
the
waiting for tree to go green
(Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land.
label
Apr 28, 2022
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Apr 28, 2022
mauricioluz
pushed a commit
to mauricioluz/plugins
that referenced
this pull request
Jan 26, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
p: camera
waiting for tree to go green
(Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new
update-excerpts
command that usescode_excerpter
andcode_excerpt_updater
to update README code snippets from actual source, which will avoid issues with README code becoming stale (not being updated for changes like NNBD, not reflecting changes to the package API), not following expected style (formatting, lint rules), or being flat out wrong (e.g., a typo that prevents compiling). Also includes a--fail-on-change
flag like the autoformat command, so that CI can validate that source code and README targets stay synchronized.Unlike the flutter/website use of these builders, they are configured per-package here to minimize the amount that someone has to learn about repository structure in order to write correct source file references, since they are entirely package-local.
camera
's README code snippets as a proof of concept.readme-check
in a follow-up.Implements flutter/flutter#89987 for this repository; it can be rolled out to flutter/packages in a follow-up
Pre-launch Checklist
dart format
.)[shared_preferences]
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.md
to add a description of the change, following repository CHANGELOG style.///
).