Autoformat changelogs #62650
Merged
Autoformat changelogs #62650
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: 0 B Total Size: 1.76 MB ℹ️ View Unchanged
|
sirreal
force-pushed
the
update/autoformat-markdown-changelogs
branch
from
5fb99bf
to
db71dd9
Compare
sirreal
requested review from
ajitbohra,
luisherranz and
DAreRodz
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 18, 2024
sirreal
commented
Jun 18, 2024
sirreal
commented
Jun 18, 2024
sirreal
force-pushed
the
update/autoformat-markdown-changelogs
branch
from
ec5290a
to
1127ee3
Compare
ellatrix
approved these changes
Jun 20, 2024
npm run format -- changelog.txt "packages/*/CHANGELOG.md"
sirreal
force-pushed
the
update/autoformat-markdown-changelogs
branch
from
1127ee3
to
62d5fc5
Compare
sirreal
force-pushed
the
update/autoformat-markdown-changelogs
branch
from
50fdde6
to
62d5fc5
Compare
|
Flaky tests detected in 62d5fc5. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9596133460
|
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?
Add configuration to autoformat the root
changelog.txtfile as markdown. It's authored with markdown syntax but the.txtextension prevents autoformatting.Apply autoformatting to markdown files:
npm run format -- changelog.txt "packages/*/CHANGELOG.md"This also adds a
linguist-language=Markdowngit attribute tochangelog.txtso that GitHub treats it as markdown. This may result in better visualization, although the file is big and GitHub may not render it at all.Follow-up to #58268
GitHub won't render the diff of changelog.txt, it's too big.
Here's a sample without whitespace changes, it's mostly adding newlines and consistently formatting lists:
Why?
Autoformatting these files helps maintain consistency. In particular, the root
changelog.txthad a lot of distracting variety.Testing Instructions
None necessary.