From c455bae27e19023f4326b1e5275d5110e0058bd6 Mon Sep 17 00:00:00 2001 From: Mark Stacey Date: Wed, 31 Jul 2024 10:27:51 -0230 Subject: [PATCH] fix: Fix GitHub release 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. --- .circleci/scripts/release-create-gh-release.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/scripts/release-create-gh-release.sh b/.circleci/scripts/release-create-gh-release.sh index 37a654798b9f..29118f57b756 100755 --- a/.circleci/scripts/release-create-gh-release.sh +++ b/.circleci/scripts/release-create-gh-release.sh @@ -66,7 +66,7 @@ then install_github_cli printf '%s\n' 'Creating GitHub Release' - release_body="$(awk -v version="${tag##v}" -f .circleci/scripts/show-changelog.awk CHANGELOG.md)" + release_body="$(awk -v version="[${tag##v}]" -f .circleci/scripts/show-changelog.awk CHANGELOG.md)" hub release create \ --attach builds/metamask-chrome-*.zip \ --attach builds-mv2/metamask-firefox-*.zip \