Repository navigation
ci(release): show what changed in the update prompt - #32
Merged
Merged
Conversation
- 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
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.
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:
--generate-notesdid. It then adds the notes of the four previous releases.@mention, and changelog links match the release page.generate_appcast --embed-release-notesembeds that HTML in the appcast. The step fails if the appcast has no<description>.--notes-fileinstead of--generate-notes, so the release page shows the same notes as the prompt.Testing
v0.11.0(existing release) andv0.12.0(not yet created). Both produced five version sections, newest first.generate_appcaston a dummy app signed with a throwaway key. The notes were embedded as a CDATA<description>and the item was signed.