docs: document required GitHub Release assets for Windows updates#237
Merged
Merged
Conversation
MarshallOfSound
approved these changes
Jun 29, 2026
georgexu99
approved these changes
Jul 1, 2026
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
3 participants
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.
Requested by Samuel Attard · Slack thread
Fixes #122
Before
The FAQ's "What kinds of assets do I need to build?" section tells you to build a
.exeand.nupkgfor Windows, but never says that the SquirrelRELEASESmanifest and the-full.nupkgpackage must actually be attached to each GitHub Release. When they're missing, Squirrel can't find the manifest it needs and updates fail silently, with the only clue buried inSquirrel-CheckForUpdate.log.After
The same FAQ section now spells out exactly which assets must be present on every GitHub Release for Windows auto-update to work: the
RELEASESmanifest, the*-full.nupkgfull package, and the*.exeinstaller, plus the optional*-delta.nupkgdelta packages. It also calls out that updates fail silently when these are absent, so the reader knows what to look for.How
Docs-only change. Added a short bullet list to the Windows portion of the "What kinds of assets do I need to build?" FAQ entry in
README.md, matching the surrounding markdown style.Generated by Claude Code