Changelogs: Standardize sections #58268
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
|
Size Change: +165 B (+0.01%) Total Size: 1.76 MB
ℹ️ View Unchanged
|
sirreal
force-pushed
the
fix/changelog-standard-sections
branch
from
ce85581 to
3e52a6a
Compare
I would bring closer the headlines with available labels for PRs and issues. @priethor, might be the best person to help you bring clarity here. I have a larger change in the release flow that would benefit from the changes you started here. |
sirreal
force-pushed
the
fix/changelog-standard-sections
branch
from
3e52a6a to
c012a63
Compare
sirreal
requested review from
ObliviousHarmony,
t-hamano,
ellatrix,
fluiddot,
dcalhoun,
gziolo,
adamsilverstein,
talldan,
swissspidy,
ajitbohra,
peterwilsoncc,
ntwb,
nerrad,
ryanwelcher,
luisherranz,
DAreRodz,
draganescu,
adamziel,
kevin940726,
dmsnell,
atimmer and
mmtr
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. |
sirreal
commented
Jun 17, 2024
| @@ -46,7 +46,7 @@ function calculateVersionBumpFromChangelog( | |||
| let changesDetected = false; | |||
| let versionBump = null; | |||
| for ( const line of lines ) { | |||
| const lineNormalized = line.toLowerCase().trimLeft(); | |||
| const lineNormalized = line.toLowerCase().trimStart(); | |||
There was a problem hiding this comment.
This is replacing a deprecated String method (alias) with its recommended replacement.
sirreal
force-pushed
the
fix/changelog-standard-sections
branch
from
6d5e6ca to
5686e54
Compare
Good spot, I've cleaned up the wrong levels in package changelogs. This also lead me to the root changelog.txt file where I did a fair amount of cleanup and standardization. It would be nice to change that file to an |
|
Flaky tests detected in 5686e54. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9561113503
|
t-hamano
approved these changes
Jun 18, 2024
Merged
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.
What?
Improve existing changelog entries to adhere to a more standard format. I've changed all similar names the seem clear to be:
I've updated the documentation as well.
I've also updated the root changelog and the changelog script to use "first-time contributors" (hyphenated) instead of "first time contributors." I understand this is correct, where "first-time" is and adjective.
Should more things be moved to standard names?
Why?
We expect a relatively standard format but nothing enforces it. Using regular sections in CHANGELOGs helps releases go smoothly and keeps changelogs clear.