Skip to content
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

Add --rc flag to changelog script #10839

Merged
merged 2 commits into from
Apr 7, 2021
Merged

Add --rc flag to changelog script #10839

merged 2 commits into from
Apr 7, 2021

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Apr 7, 2021

The changelog script now accepts an --rc flag to tell it whether to add new changes to Unreleased or to the header for the current version.

Previously this was inferred from whether the current version matched the most recent tag. However this method only works for the first update. Using a flag simplifies this logic, and makes it possible to manually re-run this for further updates to a release candidate.

Relates to #10752

Manual testing steps:

To update the changelog with unreleased changes:

  • Run yarn update-changelog
  • See that it puts changes under the "Unreleased" header

To update the changelog for a release candidate:

  • Run yarn update-changelog --rc
  • See that it puts changes under the header for the current release candidate

@Gudahtt Gudahtt requested review from kumavis and a team as code owners April 7, 2021 15:39
@Gudahtt Gudahtt requested a review from brad-decker April 7, 2021 15:39
The changelog script now accepts an `--rc` flag to tell it whether to
add new changes to `Unreleased` or to the header for the current
version.

Previously this was inferred from whether the current version matched
the most recent tag. However this method only works for the first
update. Using a flag simplifies this logic, and makes it possible to
manually re-run this for further updates to a release candidate.
@Gudahtt Gudahtt force-pushed the add-changelog-rc-flag branch from ab2a438 to a61c161 Compare April 7, 2021 15:43
@metamaskbot
Copy link
Collaborator

Builds ready [a61c161]
Page Load Metrics (589 ± 62 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint48865894
domContentLoaded38583458812962
load38683558912962
domInteractive38583458712962

development/auto-changelog.js Outdated Show resolved Hide resolved
@metamaskbot
Copy link
Collaborator

Builds ready [87bb68a]
Page Load Metrics (599 ± 53 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint457861115
domContentLoaded39975859711153
load40175959911153
domInteractive39975859711153

@Gudahtt Gudahtt merged commit 482cbfe into develop Apr 7, 2021
@Gudahtt Gudahtt deleted the add-changelog-rc-flag branch April 7, 2021 19:17
@github-actions github-actions bot locked and limited conversation to collaborators Apr 7, 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.

3 participants