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

fix: Fix GitHub release description (#26247) #26279

Merged
merged 1 commit into from
Aug 2, 2024

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Aug 1, 2024

This is a cherry-pick of #26247 for v12.0.1. Original description:

Description

For years our release scripts have been creating GitHub releases with empty descriptions. GitHub uses the commit message as the description as a default, which is always a merge commit in our case, whcih isn't very decsriptive. The release scripts are supposed to be setting the changelog entries for the current release as the description.

This broke when we last changed our CHANGELOG.md format. Specifically it was the release header change that broke this. We started surrounding the version number in square brackets, which the awk script did not expect.

The script that creates the GitHub release has been updated to pass in a version surrounded by square brackets to the awk script, so it is again able to find the relevant changelog entries.

Open in GitHub Codespaces

Related issues

Fixes: #18468

Manual testing steps

Start by checking out master. Then look at the release-create-gh-release.shscript, and run the exact same awk command that is shown there. Replace${tag##v}with the release version minus the v (e.g.12.0.0`).

Before this PR it was awk -v version="12.0.0" -f .circleci/scripts/show-changelog.awk CHANGELOG.md. This produces no output.

After this PR, its awk -v version="[12.0.0]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md. This produces the correct output.

Screenshots/Recordings

N/A

Pre-merge author checklist

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

## **Description**

For years our release scripts have been creating GitHub releases with
empty descriptions. GitHub uses the commit message as the description as
a default, which is always a merge commit in our case, whcih isn't very
decsriptive. The release scripts are supposed to be setting the
changelog entries for the current release as the description.

This broke when we last changed our CHANGELOG.md format. Specifically it
was the release header change that broke this. We started surrounding
the version number in square brackets, which the awk script did not
expect.

The script that creates the GitHub release has been updated to pass in a
version surrounded by square brackets to the awk script, so it is again
able to find the relevant changelog entries.


[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/26247?quickstart=1)

## **Related issues**

Fixes: #18468

## **Manual testing steps**

Start by checking out `master. Then look at the
`release-create-gh-release.sh` script, and run the exact same awk
command that is shown there. Replace `${tag##v}` with the release
version minus the v (e.g. `12.0.0`).

Before this PR it was `awk -v version="12.0.0" -f
.circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces no
output.

After this PR, its `awk -v version="[12.0.0]" -f
.circleci/scripts/show-changelog.awk CHANGELOG.md`. This produces the
correct output.

## **Screenshots/Recordings**

N/A

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
@Gudahtt Gudahtt marked this pull request as ready for review August 1, 2024 13:13
@Gudahtt Gudahtt requested review from kumavis and a team as code owners August 1, 2024 13:13
@metamaskbot
Copy link
Collaborator

Builds ready [d666b41]
Page Load Metrics (41 ± 2 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint5813375157
domContentLoaded815911
load39504132
domInteractive815911

Copy link

codecov bot commented Aug 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.61%. Comparing base (c880e07) to head (d666b41).

Additional details and impacted files
@@               Coverage Diff                @@
##           Version-v12.0.1   #26279   +/-   ##
================================================
  Coverage            65.61%   65.61%           
================================================
  Files                 1368     1368           
  Lines                54600    54600           
  Branches             14183    14183           
================================================
  Hits                 35825    35825           
  Misses               18775    18775           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Gudahtt Gudahtt added team-extension-platform needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) labels Aug 1, 2024
@Gudahtt Gudahtt requested a review from a team August 1, 2024 21:10
Copy link
Contributor

@desi desi left a comment

Choose a reason for hiding this comment

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

Tested - LGTM

@Gudahtt Gudahtt merged commit cc66b50 into Version-v12.0.1 Aug 2, 2024
77 checks passed
@Gudahtt Gudahtt deleted the v12.0.1/fix-release-description branch August 2, 2024 17:40
@github-actions github-actions bot locked and limited conversation to collaborators Aug 2, 2024
@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Aug 2, 2024
@DDDDDanica
Copy link
Contributor

Tested in Version-v12.0.1 branch. ✅
截屏2024-08-05 19 20 42

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants