Update the changelog when creating an RC #10795

Gudahtt · 2021-04-01T14:18:05Z

The changelog will now be automatically updated when a release branch is created. A new release header along with changelog entries for any new commits will be added.

Note that this changelog will still need to be manually cleaned up, but it's one less manual step at least.

The old Bash script for adding a new release header to the changelog has been removed, as that functionality is now built into the changelog update script.

A new script has been added to commit any changes made to the manifest and changelog. This step used to happen at the end of the bump manifest version script, but now the changelog update relies upon the manifest version bump happening first, so it needed to be re-ordered. The changes should only be committed on the first run of the branch, as it's contingent upon the manifest changing (due to the version bump). Further changelog updates won't trigger new automatic commits.

Relates to #10752

Manual testing steps:

Create a new release branch
See that it updates the changelog automatically

Gudahtt · 2021-04-01T14:18:19Z

~~This depends upon #10794~~

metamaskbot · 2021-04-01T14:33:12Z

Builds ready [e0bf1cc]

builds: chrome, firefox, opera
bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
build viz: Build System
code coverage: Report
storybook: Storybook
all artifacts

Page Load Metrics (665 ± 62 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	45	85	59	10	5
		domContentLoaded	358	859	664	129	62
		load	359	861	665	129	62
		domInteractive	357	859	663	129	62

metamaskbot · 2021-04-01T15:46:59Z

Builds ready [e7c7055]

builds: chrome, firefox, opera
bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
build viz: Build System
code coverage: Report
storybook: Storybook
all artifacts

Page Load Metrics (549 ± 43 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	43	71	53	9	4
		domContentLoaded	330	672	547	90	43
		load	336	673	549	89	43
		domInteractive	330	672	546	89	43

metamaskbot · 2021-04-02T01:40:24Z

Builds ready [79b8ed5]

builds: chrome, firefox, opera
bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
build viz: Build System
code coverage: Report
storybook: Storybook
all artifacts

Page Load Metrics (559 ± 37 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	43	72	58	9	4
		domContentLoaded	374	675	557	77	37
		load	376	676	559	77	37
		domInteractive	374	675	557	77	37

metamaskbot · 2021-04-02T15:24:07Z

Builds ready [0402931]

builds: chrome, firefox, opera
bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
build viz: Build System
code coverage: Report
storybook: Storybook
all artifacts

Page Load Metrics (571 ± 40 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	44	72	56	9	4
		domContentLoaded	373	661	570	83	40
		load	375	663	571	83	40
		domInteractive	373	661	570	83	40

rekmarks

Looks good except for a typo.

.circleci/scripts/release-commit-verison-bump.sh

The changelog will now be automatically updated when a release branch is created. A new release header along with changelog entries for any new commits will be added. Note that this changelog will still need to be manually cleaned up, but it's one less manual step at least. The old Bash script for adding a new release header to the changelog has been removed, as that functionality is now built into the changelog update script. A new script has been added to commit any changes made to the manifest and changelog. This step used to happen at the end of the bump manifest version script, but now the changelog update relies upon the manifest version bump happening first, so it needed to be re-ordered. The changes should only be committed on the first run of the branch, as it's contingent upon the manifest changing (due to the version bump). Further changelog updates won't trigger new automatic commits.

rekmarks

LGTM!

Gudahtt · 2021-04-02T20:43:57Z

I've just created the branch Version-v9.3.1 to test this, just to double check that it all works 👀

rekmarks · 2021-04-02T20:52:36Z

ffffuuuuuuu

@lavamoat/allow-scripts automatically updating configuration

removing unneeded configuration for packages:
- fsevents
Done in 2.65s.
allow-scripts configuration requires updates

The check for manifest changes was wrong on two counts. Firstly it was supposed to check that there *are* changes, but instead it was bailing if there were *no* changes (the opposite of what was intended). Second, it was including changelog changes as well, when it should have only considered manifest changes.

.circleci/scripts/release-commit-version-bump.sh

Gudahtt · 2021-04-02T20:59:16Z

It worked! d6b5abd

... after fixing a couple more mistakes 😅 . I put each bug fix in a separate commit - check out the most recent two since your approval to see what they were.

Gudahtt · 2021-04-02T21:04:07Z

That status check shouldn't affect this PR thankfully, because this isn't a release branch. It was only triggered because this commit was used in a release branch. GitHub applies these status checks by commit it seems, not by branch.

rekmarks

Alright, now it looks good!

metamaskbot · 2021-04-02T21:10:50Z

Builds ready [c6c5daa]

builds: chrome, firefox, opera
bundle viz: background, ui, inpage, contentscript, ui-libs, bg-libs, phishing-detect
build viz: Build System
code coverage: Report
storybook: Storybook
all artifacts

Page Load Metrics (513 ± 38 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	43	71	52	8	4
		domContentLoaded	341	602	511	79	38
		load	343	603	513	79	38
		domInteractive	341	602	511	79	38

Gudahtt force-pushed the add-release-header-when-updating-changelog branch from 5ed8808 to ddfd922 Compare April 1, 2021 15:28

Gudahtt force-pushed the update-changelog-when-creating-RC branch from e0bf1cc to e7c7055 Compare April 1, 2021 15:30

Base automatically changed from add-release-header-when-updating-changelog to develop April 1, 2021 23:39

Gudahtt force-pushed the update-changelog-when-creating-RC branch from e7c7055 to 79b8ed5 Compare April 2, 2021 01:24

Gudahtt marked this pull request as ready for review April 2, 2021 01:24

Gudahtt requested review from kumavis and a team as code owners April 2, 2021 01:24

Gudahtt requested a review from brad-decker April 2, 2021 01:24

Gudahtt force-pushed the update-changelog-when-creating-RC branch from 79b8ed5 to 0402931 Compare April 2, 2021 15:08

Gudahtt mentioned this pull request Apr 2, 2021

Add links to release headers #10808

Merged

rekmarks requested changes Apr 2, 2021

View reviewed changes

.circleci/scripts/release-commit-verison-bump.sh Outdated Show resolved Hide resolved

Gudahtt added 2 commits April 2, 2021 18:08

Fix typo in script filename

02ad6c8

Gudahtt force-pushed the update-changelog-when-creating-RC branch from 0402931 to 02ad6c8 Compare April 2, 2021 20:39

rekmarks previously approved these changes Apr 2, 2021

View reviewed changes

Make the new script executable

3488733

Gudahtt dismissed rekmarks’s stale review via 3488733 April 2, 2021 20:45

rekmarks reviewed Apr 2, 2021

View reviewed changes

.circleci/scripts/release-commit-version-bump.sh Show resolved Hide resolved

rekmarks approved these changes Apr 2, 2021

View reviewed changes

Gudahtt merged commit 6878035 into develop Apr 2, 2021

Gudahtt deleted the update-changelog-when-creating-RC branch April 2, 2021 21:11

github-actions bot locked and limited conversation to collaborators Apr 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the changelog when creating an RC #10795

Update the changelog when creating an RC #10795

Gudahtt commented Apr 1, 2021

Gudahtt commented Apr 1, 2021 •

edited by rekmarks

Loading

metamaskbot commented Apr 1, 2021

metamaskbot commented Apr 1, 2021

metamaskbot commented Apr 2, 2021

metamaskbot commented Apr 2, 2021

rekmarks left a comment

rekmarks left a comment

Gudahtt commented Apr 2, 2021

rekmarks commented Apr 2, 2021

Gudahtt commented Apr 2, 2021

Gudahtt commented Apr 2, 2021

rekmarks left a comment

metamaskbot commented Apr 2, 2021

Update the changelog when creating an RC #10795

Update the changelog when creating an RC #10795

Conversation

Gudahtt commented Apr 1, 2021

Gudahtt commented Apr 1, 2021 • edited by rekmarks Loading

metamaskbot commented Apr 1, 2021

metamaskbot commented Apr 1, 2021

metamaskbot commented Apr 2, 2021

metamaskbot commented Apr 2, 2021

rekmarks left a comment

Choose a reason for hiding this comment

rekmarks left a comment

Choose a reason for hiding this comment

Gudahtt commented Apr 2, 2021

rekmarks commented Apr 2, 2021

Gudahtt commented Apr 2, 2021

Gudahtt commented Apr 2, 2021

rekmarks left a comment

Choose a reason for hiding this comment

metamaskbot commented Apr 2, 2021

Gudahtt commented Apr 1, 2021 •

edited by rekmarks

Loading