Skip to content

Update changelog headers and fix dates#10805

Merged
Gudahtt merged 2 commits intodevelopfrom
update-release-header-format-and-fix-dates
Apr 2, 2021
Merged

Update changelog headers and fix dates#10805
Gudahtt merged 2 commits intodevelopfrom
update-release-header-format-and-fix-dates

Conversation

@Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Apr 2, 2021

The changelog release header format has been updated to match the "keep a changelog" format. Each header is now the bracketed version number followed by a dash, then the release date in ISO-8601 format.

The release dates in each header were also updated to match the date of the corresponding GitHub Release. Many of these dates were incorrect because they were set on the day we created the release candidate, rather than on the day of release.

Any changelog release entries without a corresponding GitHub release was left with the date already specified.

The three oldest release headers were missing dates. For the first two, I used the date of the version bump commit. For the third, I removed it since no changes were listed anyway, and it represented a range of releases rather than a single one.

The auto-changelog.js script has been updated to account for this new format as well.

Manual testing steps:

For RC changelog updates with existing release header:

  • Bump the version in app/manifest/_base.json, to simulate an RC-like environment
  • Add a new release header to the changelog for the new version
  • Run yarn update-changelog
  • See that it places changelog entries under the new release header

For updates without a release header:

  • Bump the version in app/manifest/_base.json, to simulate an RC-like environment
  • Run yarn update-changelog
  • See that it places changelog entries under the newly added release header

@Gudahtt Gudahtt force-pushed the update-release-header-format-and-fix-dates branch from 6e76fe0 to 7c59774 Compare April 2, 2021 01:23
@Gudahtt Gudahtt marked this pull request as ready for review April 2, 2021 01:24
@Gudahtt Gudahtt requested review from a team and kumavis as code owners April 2, 2021 01:24
@Gudahtt Gudahtt requested a review from darkwing April 2, 2021 01:24
@metamaskbot
Copy link
Collaborator

Builds ready [7c59774]
Page Load Metrics (570 ± 43 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint448558147
domContentLoaded3707385689043
load3717395709043
domInteractive3697375689043

The changelog release header format has been updated to match the "keep
a changelog" [1] format. Each header is now the bracketed version
number followed by a dash, then the release date in ISO-8601 format.

The release dates in each header were also updated to match the date of
the corresponding GitHub Release [2]. Many of these dates were
incorrect because they were set on the day we created the release
candidate, rather than on the day of release.

Any changelog release entries without a corresponding GitHub release
was left with the date already specified.

The three oldest release headers were missing dates. For the first two,
I used the date of the version bump commit. For the third, I removed it
since no changes were listed anyway, and it represented a range of
releases rather than a single one.

The `auto-changelog.js` script has been updated to account for this new
format as well.

[1]: https://keepachangelog.com/en/1.0.0/
[2]: https://github.com/MetaMask/metamask-extension/releases
@Gudahtt Gudahtt force-pushed the update-release-header-format-and-fix-dates branch from 7c59774 to 45cfa63 Compare April 2, 2021 15:08
darkwing
darkwing previously approved these changes Apr 2, 2021
@metamaskbot
Copy link
Collaborator

Builds ready [45cfa63]
Page Load Metrics (618 ± 46 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint49705963
domContentLoaded4267376179646
load4277386189646
domInteractive4257376179646

@Gudahtt
Copy link
Member Author

Gudahtt commented Apr 2, 2021

Oops - the add a new release part didn't work after all! Fixed here: 27890c5

@metamaskbot
Copy link
Collaborator

Builds ready [27890c5]
Page Load Metrics (560 ± 56 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint48725874
domContentLoaded37068755811656
load37268856011656
domInteractive37068755811656

- [#7558](https://github.com/MetaMask/metamask-extension/pull/7558): Use localized messages for NotificationModal buttons

## 7.7.0 Thu Nov 28 2019 [WITHDRAWN]
## [7.7.0] - 2019-12-03 [WITHDRAWN]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😭

@rekmarks
Copy link
Member

rekmarks commented Apr 2, 2021

@Gudahtt tangentially related: how do we plan to record the correct dates in the changelog going forward?

@Gudahtt
Copy link
Member Author

Gudahtt commented Apr 2, 2021

That part isn't automated yet, but I had planned to have that be an automated post-release commit.

Copy link
Member

@rekmarks rekmarks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

This must've been tedious. Thanks for doing it.

@Gudahtt Gudahtt merged commit 13862cb into develop Apr 2, 2021
@Gudahtt Gudahtt deleted the update-release-header-format-and-fix-dates branch April 2, 2021 20:47
@github-actions github-actions bot locked and limited conversation to collaborators Apr 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants