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

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Jul 31, 2024

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.

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.
Copy link

@Gudahtt Gudahtt marked this pull request as ready for review July 31, 2024 13:06
@Gudahtt Gudahtt requested review from kumavis and a team as code owners July 31, 2024 13:06
@hjetpoluru hjetpoluru self-requested a review July 31, 2024 13:10
Copy link
Contributor

@hjetpoluru hjetpoluru left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.95%. Comparing base (44ecc0f) to head (c455bae).
Report is 5 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop   #26247   +/-   ##
========================================
  Coverage    69.95%   69.95%           
========================================
  Files         1411     1411           
  Lines        49963    49963           
  Branches     13800    13800           
========================================
  Hits         34948    34948           
  Misses       15015    15015           

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

@metamaskbot
Copy link
Collaborator

Builds ready [c455bae]
Page Load Metrics (89 ± 28 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint642901205928
domContentLoaded9198354622
load39260895928
domInteractive9198354622
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@Gudahtt Gudahtt merged commit c23a62b into develop Aug 1, 2024
78 of 79 checks passed
@Gudahtt Gudahtt deleted the fix-github-release-contents branch August 1, 2024 12:35
@github-actions github-actions bot locked and limited conversation to collaborators Aug 1, 2024
@metamaskbot metamaskbot added the release-12.4.0 Issue or pull request that will be included in release 12.4.0 label Aug 1, 2024
@gauthierpetetin gauthierpetetin added release-12.3.0 Issue or pull request that will be included in release 12.3.0 and removed release-12.4.0 Issue or pull request that will be included in release 12.4.0 labels Sep 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release-12.3.0 Issue or pull request that will be included in release 12.3.0 team-wallet-framework
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Fix changelog on the release page
7 participants