Skip to content

ci(release): show what changed in the update prompt - #32

Merged
WolffTech merged 1 commit into
mainfrom
t3code/show-updater-release-notes
Sep 25, 2026
Merged

WolffTech merged 1 commit into
mainfrom
t3code/show-updater-release-notes

Conversation

@WolffTech

Copy link
Copy Markdown
Owner

The update prompt only said a new version was available. It never showed what changed, even though every GitHub release has generated notes.

The release workflow now embeds the release notes in the Sparkle appcast, so the standard update window shows them. No app change is needed: the notes come from the feed, so current installs will see them from the next release on.

Sparkle only shows the notes of the version it offers, so someone jumping from 0.9 to 0.12 would miss 0.10 and 0.11. The prompt also includes the notes of the four previous releases, newest first, each under its own Version x.y.z heading.

How it works:

  • Collect release notes (new step) uses the existing release's notes if you created the release in the GitHub UI. Otherwise it asks GitHub to generate them, the same way --generate-notes did. It then adds the notes of the four previous releases.
  • GitHub's Markdown API renders the notes to HTML, so PR, @mention, and changelog links match the release page. generate_appcast --embed-release-notes embeds that HTML in the appcast. The step fails if the appcast has no <description>.
  • A plain pushed tag is published with --notes-file instead of --generate-notes, so the release page shows the same notes as the prompt.

Testing

  • Ran the new step locally against the real repository for v0.11.0 (existing release) and v0.12.0 (not yet created). Both produced five version sections, newest first.
  • Rendered the notes and ran Sparkle 2.10.0's generate_appcast on a dummy app signed with a throwaway key. The notes were embedded as a CDATA <description> and the item was signed.
  • Not tested: how the notes look in the update window itself. That needs a real release.

- Embed GitHub release notes in the Sparkle appcast
- Include notes from the four prior releases for skipped versions
- Publish pushed tags with the same notes shown in the prompt
@WolffTech
WolffTech merged commit b7931aa into main Sep 25, 2026
2 checks passed
@WolffTech
WolffTech deleted the t3code/show-updater-release-notes branch November 10, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant