This repository was archived by the owner on Feb 22, 2023. It is now read-only.
[tools] Validate code excerpt configuration #6286
Merged
Conversation
This file contains hidden or 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
Ensures that if a REAME uses code excerpting, the package is configured to drive it. This avoids the (so far common) mistake of adding tags when the block check fails, but not setting up the package so that they actually work. Also adds a link to the wiki for the missing excerpt tag error so that people find the instructions sooner, rather than adding tags via guess-and-check. Fixes flutter/flutter#109231
tarrinneal
reviewed
Aug 17, 2022
There was a problem hiding this comment.
As far as I can tell, this looks good. I'll let bparrishMines give the approval, since I'm still not sure I know what all to check for.
bparrishMines
approved these changes
Aug 26, 2022
| // This is a shared constant to ensure that both readme-check and | ||
| // update-excerpt are looking for the same file, so that readme-check can't | ||
| // get out of sync with what actually drives excerpting. | ||
| const String kReadmeExcerptConfigPath = 'example/build.excerpt.yaml'; |
There was a problem hiding this comment.
nit: I don't think we typically start constants with a k in Dart. I'm assuming this the pattern for this package?
There was a problem hiding this comment.
I learned recently that the Flutter style guide disagrees with Dart style on this for global constants:
tarrinneal
pushed a commit
to tarrinneal/plugins
that referenced
this pull request
Aug 26, 2022
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Aug 29, 2022
tarrinneal
added a commit
that referenced
this pull request
Aug 29, 2022
* Endorse ios and update examples * [gh_actions]: Bump lewagon/wait-on-check-action from 1.1.1 to 1.1.2 (#6300) * [gh_actions]: Bump github/codeql-action from 2.1.18 to 2.1.19 (#6299) * [gh_actions]: Bump ossf/scorecard-action from 1.1.1 to 1.1.2 (#6071) * Roll Flutter from abfba69 to 6d3f782 (74 revisions) (#6314) * [gh_actions]: Bump actions/labeler from 4.0.0 to 4.0.1 (#6262) * Roll Flutter from 6d3f782 to 000b96c (13 revisions) (#6317) * Adds info about commands requiring Flutter-bundled dart (#6312) * [tools] Validate code excerpt configuration (#6286) * temp lower ios version number * Update README supported table * remove unused routes * lower version num * iOS vs ios * todo * don't ignore ios * add ios files * add license block * fix Uint8 error * relocate import * Exclude ios integration test for file_selector * fix requests Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: engine-flutter-autoroll <[email protected]> Co-authored-by: stuartmorgan <[email protected]> Co-authored-by: Tarrin Neal <[email protected]>
mauricioluz
pushed a commit
to mauricioluz/plugins
that referenced
this pull request
Jan 26, 2023
mauricioluz
pushed a commit
to mauricioluz/plugins
that referenced
this pull request
Jan 26, 2023
* Endorse ios and update examples * [gh_actions]: Bump lewagon/wait-on-check-action from 1.1.1 to 1.1.2 (flutter#6300) * [gh_actions]: Bump github/codeql-action from 2.1.18 to 2.1.19 (flutter#6299) * [gh_actions]: Bump ossf/scorecard-action from 1.1.1 to 1.1.2 (flutter#6071) * Roll Flutter from abfba69 to 6d3f782 (74 revisions) (flutter#6314) * [gh_actions]: Bump actions/labeler from 4.0.0 to 4.0.1 (flutter#6262) * Roll Flutter from 6d3f782 to 000b96c (13 revisions) (flutter#6317) * Adds info about commands requiring Flutter-bundled dart (flutter#6312) * [tools] Validate code excerpt configuration (flutter#6286) * temp lower ios version number * Update README supported table * remove unused routes * lower version num * iOS vs ios * todo * don't ignore ios * add ios files * add license block * fix Uint8 error * relocate import * Exclude ios integration test for file_selector * fix requests Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: engine-flutter-autoroll <[email protected]> Co-authored-by: stuartmorgan <[email protected]> Co-authored-by: Tarrin Neal <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Ensures that if a REAME uses code excerpting, the package is configured
to drive it. This avoids the (so far common) mistake of adding tags when
the block check fails, but not setting up the package so that they
actually work.
Also adds a link to the wiki for the missing excerpt tag error so that
people find the instructions sooner, rather than adding tags via
guess-and-check.
Fixes flutter/flutter#109231
Pre-launch Checklist
dart format.)[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style.///).