desktop-release: surface .dmg links + auto-changelog in notes#45
Merged
Conversation
The raw asset list (zips, blockmaps, latest-mac.yml) is overwhelming for end users who only want the installer. Append a step that builds a release body with direct .dmg download links at the top and GitHub's auto-generated commit list below.
There was a problem hiding this comment.
Pull request overview
This PR enhances the macOS desktop release workflow to publish friendlier GitHub Release notes. After the existing publish/promote steps, a new step builds a notes body that highlights the .dmg download links and appends GitHub's auto-generated changelog, then rewrites the release body via gh release edit.
Changes:
- Adds a
Write release notesstep indesktop-release.ymlthat runs after publish/promote. - Calls
/repos/{repo}/releases/generate-notesto obtain GitHub's auto-generated changelog and prepends a## Downloadsection with direct arm64/x64.dmglinks. - Handles both workflow_dispatch and tag-push triggers by falling back from
needs.bump.outputs.reftogithub.ref_name.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Owner
Author
|
Fixes #42 |
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
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
Write release notesstep todesktop-release.ymlthat runs after the publish/promote steps..dmgfiles, then a horizontal rule, then GitHub's auto-generatedWhat's Changed/New Contributors/Full Changelogsection.v0.0.1manually so the current release already shows the new format.Test plan
rcorreleaseworkflow run produces a release whose body opens with the Download section and is followed by the auto-changelog.latest-mac.yml) still renders below — those stay because electron-updater needs them.