-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Conversation
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.
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
Builds ready [c455bae]
Page Load Metrics (89 ± 28 ms)
Bundle size diffs
|
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.
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