-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Autoformat changelogs #62650
Autoformat changelogs #62650
Conversation
Size Change: 0 B Total Size: 1.76 MB ℹ️ View Unchanged
|
5fb99bf
to
db71dd9
Compare
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. |
ec5290a
to
1127ee3
Compare
npm run format -- changelog.txt "packages/*/CHANGELOG.md"
1127ee3
to
62d5fc5
Compare
50fdde6
to
62d5fc5
Compare
Flaky tests detected in 62d5fc5. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9596133460
|
What?
Add configuration to autoformat the root
changelog.txt
file as markdown. It's authored with markdown syntax but the.txt
extension prevents autoformatting.Apply autoformatting to markdown files:
npm run format -- changelog.txt "packages/*/CHANGELOG.md"
This also adds a
linguist-language=Markdown
git attribute tochangelog.txt
so 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.txt
had a lot of distracting variety.Testing Instructions
None necessary.