Improve changelog generation script to support closed milestones and avoid adding an empty other section #1351
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
westonruter
added
[Type] Bug
westonruter
requested review from
mukeshpanchal27,
felixarntz and
thelovekesh
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
swissspidy
approved these changes
Jul 16, 2024
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
During the release process for Performance Lab 3.3.0, there were a couple papercuts I noticed when generating the changelogs.
First, in order to satisfy
npm run versionsI added an empty changelog entry to the changelog. When runningnpm run readme, it would then take that empty changelog entry and put it in the**Other**section, erroneously. This PR fixes this by omitting this other section if it is empty. It also fixes insertion of a blank line break after the version heading.Secondly, when attempting to generate a changelog for a closed milestone, the script would fail saying
Cannot find milestone by title. This was confusing because the milestone does exist, but it is just closed. So this PR includes both open and closed milestones in the lookup.Lastly, I corrected a changelog entry for Performance Lab.