fix: generate release notes when publishing a tagged release - #541
Open
frarredondo wants to merge 1 commit into
Open
fix: generate release notes when publishing a tagged release#541frarredondo wants to merge 1 commit into
frarredondo wants to merge 1 commit into
Conversation
The publish-release job only marked releases non-draft; it never set a body, so every stable release shipped with empty notes. Use the releases API's generate_release_notes option so each publish gets an auto-generated "What's Changed" summary from merged PRs since the previous release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #540. Every published release has an empty body, so nobody can tell what changed without diffing tags by hand. Traced it down: electron-builder creates the release with no notes, and the publish-release job just does
gh release edit --draft=false --latest, never touching notes either. Nothing in the pipeline ever writes a body.Swapped that
gh release editcall for a direct API PATCH that turns ongenerate_release_notes. That's the same thing GitHub's own "Generate release notes" button does, pulls a "What's Changed" list from merged PRs since the last tag. No changelog file to maintain, no extra step.Also pinned
nameexplicitly (${tag#v}) so the release title doesn't shift when GitHub fills in the rest.Heads up: this only helps going forward. I don't have push access to this repo so I can't backfill notes on the releases already out there (v2.4.82 and earlier).
Test plan
gh release view --json bodybefore writing the fixghcall for an API PATCH doing a superset of what it did before (draft=false, make_latest) plus generate_release_notes