-
Notifications
You must be signed in to change notification settings - Fork 3.5k
[tool] Add check for blank lines in CHANGELOG lists #10346
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
base: main
Are you sure you want to change the base?
[tool] Add check for blank lines in CHANGELOG lists #10346
Conversation
|
It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging. 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. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group. |
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.
Code Review
This pull request introduces a new check in the version-check command to detect blank lines between list items in CHANGELOG.md files, which can cause rendering issues on pub.dev. The implementation uses a regular expression for this detection.
My review has found a few issues. Most importantly, the new functionality is not covered by tests. Additionally, there are opportunities for performance improvements by making the RegExp a constant and by optimizing how the changelog file is read. Please see the detailed comments for suggestions.
|
Thanks for the contribution! You’ve checked boxes in the PR checklist above that are not reflected in this PR, so I’m assuming this is a work in progress and am marking it as a Draft. Please review the checklist, updating the PR as appropriate, and when the state of the PR as posted reflects the checklist please feel free to mark it as ready for review. |
Blank lines between list items in a CHANGELOG.md file cause pub.dev to render them as separate lists, which is not the intended style for the project. This commit updates the `version-check` command to detect this pattern using a multi-line regex. If a match is found, the check fails and prints the offending lines to the console to help the author fix it. Signed-off-by: Lorenzo Croce <lorenzo.croce@arenastudios.it>
Moves the regular expression for checking blank lines in lists to a static final field in `VersionCheckCommand` so that it is compiled only once instead of on every execution of `_findBlankLineInList`. Additionally, the `CHANGELOG.md` is now read entirely into a string first. This unified content is then used for both line-by-line version extraction and the subsequent regex-based formatting check. Signed-off-by: Lorenzo Croce <lorenzo.croce@arenastudios.it>
Adds unit tests to verify that the `version-check` command correctly fails when it detects blank lines between list items in a CHANGELOG, as this breaks list rendering on pub.dev. Tests are added for both simple lists and nested lists. Also includes a minor formatting fix for the error message. Signed-off-by: Lorenzo Croce <lorenzo.croce@arenastudios.it>
05ff48f to
8c95c99
Compare
Applies `dart format` to the `version_check_command_test.dart` file to resolve minor formatting inconsistencies. Signed-off-by: Lorenzo Croce <lorenzo.croce@arenastudios.it>
Signed-off-by: Lorenzo Croce <lorenzo.croce@arenastudios.it>
|
@stuartmorgan-g All other failures (such as those related to android_platform_tests, ios_platform_tests, and dart_unit_tests) appear to be flaky issues or related to the current broken tree-status, and are not connected to the changes in this Pull Request. |
Blank lines between list items in a CHANGELOG.md file cause pub.dev to render them as separate lists, which is not the intended style for the project.
This commit updates the
version-checkcommand to detect this pattern using a multi-line regex. If a match is found, the check fails and prints the offending lines to the console to help the author fix it.Fixes flutter/flutter#177511
Pre-Review Checklist
[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under1.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under1.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2 ↩3