Add categories to each changelog release#10837
Merged
Conversation
Each changelog release now has category headers. The standard "keep a changelog" [1] categories are used, along with the addition of "Uncategorized" for any changes that have not yet been categorized. The changelog script has been updated to add this "Uncategorized" header if it isn't already present, and to place any new commits under this header. The changelog has been updated to property categorize each change in recent releases, and to place changes in older releases under the header "Uncategorized". [1]: https://keepachangelog.com/en/1.0.0/
Gudahtt
commented
Apr 7, 2021
| const changelog = await fs.readFile(changelogFilename, { encoding: 'utf8' }); | ||
| const changelogLines = changelog.split('\n'); | ||
|
|
||
| const prNumbersWithChangelogEntries = []; |
Member
Author
There was a problem hiding this comment.
This was moved earlier in the script to allow the early exit on line 99, to ensure we don't add the 'Uncategorized' header to the "Unreleased" section if there are no changes.
As a bonus, it now avoids creating a new release header if there are no commits as well! Though that shouldn't happen generally.
Collaborator
Builds ready [1f60090]
Page Load Metrics (610 ± 61 ms)
|
A few releases were missing the 'Uncategorized' header due to inconsistencies in formatting. The formatting for each release has been made consistent, and any missing 'Uncategorized' headers have been added.
Gudahtt
commented
Apr 7, 2021
| - Add Parity compatibility, fixing Geth dependency issues. | ||
| - Add a link to the transaction in history that goes to https://metamask.github.io/eth-tx-viz | ||
| too help visualize transactions and to where they are going. | ||
| - Add a link to the transaction in history that goes to https://metamask.github.io/eth-tx-viz to help visualize transactions and to where they are going. |
Member
Author
There was a problem hiding this comment.
I moved this onto one line to make the formatting more consistent and easier to parse. I also fixed a typo here (too => to).
Gudahtt
commented
Apr 7, 2021
| - Fixed bug where if you send a transaction from within MetaMask extension the | ||
| popup notification opens up. | ||
| ### Uncategorized | ||
| - Fixed bug where if you send a transaction from within MetaMask extension the popup notification opens up. |
Member
Author
There was a problem hiding this comment.
This was moved onto one line as well.
Gudahtt
commented
Apr 7, 2021
|
|
||
| Made seed word restoring BIP44 compatible. | ||
| ### Uncategorized | ||
| - Made seed word restoring BIP44 compatible. |
Member
Author
There was a problem hiding this comment.
These older releases didn't have a - in front of their changes. I've added it to make them consistent with the others.
Collaborator
Builds ready [8764b04]
Page Load Metrics (622 ± 58 ms)
|
brad-decker
previously approved these changes
Apr 7, 2021
Contributor
brad-decker
left a comment
There was a problem hiding this comment.
This LGTM though I'd like some clarification on how the various categories are determined. What differentiates changed/added vs fixed?
Member
Author
|
The keep a changelog spec describes the categories as follows:
Sometimes the line between what counts as a change to an existing feature v.s a new feature v.s a bug fix is blurry. But that's fine.We can pick whichever we think would be most useful for readers. |
Gudahtt
commented
Apr 7, 2021
The "Add setting to hide zero balance tokens" changelog entry was accidentally moved from v9.2.0 to v9.2.1. It has been moved back.
Collaborator
Builds ready [a7e6e05]
Page Load Metrics (590 ± 41 ms)
|
brad-decker
approved these changes
Apr 7, 2021
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Each changelog release now has category headers. The standard "keep a changelog" categories are used, along with the addition of "Uncategorized" for any changes that have not yet been categorized.
The changelog script has been updated to add this "Uncategorized" header if it isn't already present, and to place any new commits under this header.
The changelog has been updated to property categorize each change in recent releases, and to place changes in older releases under the header "Uncategorized".
Relates to #10752
Manual testing steps:
For development changelog updates:
yarn update-changelogFor RC changelog updates with existing release header:
versioninapp/manifest/_base.json, to simulate an RC-like environmentyarn update-changelogFor updates without a release header:
versioninapp/manifest/_base.json, to simulate an RC-like environmentyarn update-changelog