BREAKING: Format changelog using Prettier #100
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
Mrtenz
changed the title
mcmire
previously approved these changes
Nov 15, 2023
|
Merge conflicts, sorry 😩 |
Mrtenz
force-pushed
the
mrtenz/changelog-prettier
branch
from
1e113d0 to
f955c60
Compare
|
Updated dependencies detected. Learn more about Socket for GitHub ↗︎
|
3 tasks
Gudahtt
added a commit
to MetaMask/core
that referenced
this pull request
Jan 26, 2024
## Explanation <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * If your primary goal was to update one package but you found you had to update another one along the way, why did you do so? * If you had to upgrade a dependency, why did you do so? --> The newest version of `create-release-branch` formats changelogs with Prettier after it updates them. This assumes that the project using `create-release-branch` (this one) already formats changelogs via Prettier. This isn't enabled yet, so this commit does that. ## References Also see: MetaMask/create-release-branch#100 ## Changelog <!-- If you're making any consumer-facing changes, list those changes here as if you were updating a changelog, using the template below as a guide. (CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or FIXED. For security-related issues, follow the Security Advisory process.) Please take care to name the exact pieces of the API you've added or changed (e.g. types, interfaces, functions, or methods). If there are any breaking changes, make sure to offer a solution for consumers to follow once they upgrade to the changes. Finally, if you're only making changes to development scripts or tests, you may replace the template below with "None". --> (N/A) ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Co-authored-by: Mark Stacey <[email protected]>
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.
MetaMask/auto-changelog#155 adds a method to format changelogs using Prettier. I've enabled this option here.
This is a breaking change, since it will change the default formatting of the changelog in new release PRs. Packages updating to the next version of this package should simultaneously enable the
--prettierflag onauto-changelog(see MetaMask/metamask-module-template#219).