A workflow (.github/workflows/release.yml) builds the macOS and Windows installers on GitHub's servers and attaches them to a Release, including the latest*.yml metadata the in-app auto-updater checks.
To cut a release:
- Bump the version with
npm version 1.2.1 --no-git-tag-version(it changespackage.jsonand the two app entries inpackage-lock.json, nothing else) and add a matching## [1.2.1]entry at the top ofCHANGELOG.md. - Create a matching tag prefixed with
v(e.g.v1.2.1) and push it, either way works; the first is the safer one:- From GitHub Desktop (recommended): Repository → Push first and wait for Tests to be green under Actions; then History → right-click the commit → Create Tag… →
v1.2.1→ Create Tag, then Repository → Push again (Desktop pushes the tag with it). The workflow creates the release itself as a draft, with that version's entry inCHANGELOG.mdas its notes, and publishes it only once every installer is attached and checked. - On github.com: GitHub Desktop Repository → Push first, then Releases → Draft a new release → Choose a tag → type
v1.2.1→ Create new tag: v1.2.1 on publish → leave the notes empty (the workflow writes them fromCHANGELOG.md; do not click Generate release notes, which would replace them with raw commit titles, and leave Set as a pre-release unticked, or the in-app updater will skip the version) → Publish release.
- From GitHub Desktop (recommended): Repository → Push first and wait for Tests to be green under Actions; then History → right-click the commit → Create Tag… →
- The workflow runs on its own: it builds both installers, uploads them, checks that every file it built is really there, byte for byte, and only then publishes the release, so a release the workflow creates never appears with an empty Assets list. (A release you published yourself from the Releases page is public straight away and gets its files a few minutes later, as before.) The install instructions are added under the notes.
If a build turns red under Actions, a release the workflow created stays a Draft only you can see; one you published yourself from the Releases page stays public with files missing, fix it, never delete it. Open the run: the notes job says what to fix when the problem is the tag or the notes (a tag that does not match the version in
package.json, a version with noCHANGELOG.mdentry, or two saved drafts for one tag); otherwise read the red build step. Once the cause is fixed, use the run's Re-run failed jobs first, only the red build repeats, and the files the green one attached stay. Run workflow with the tag (below) is for a release whose Assets list is empty: a fresh run compares its new files with the ones already attached, and a file that differs in size stops it until you delete that file on the release page.
The tag is what ships. The Releases page's Latest and the in-app updater both read the newest
v*tag. A version bumped inpackage.jsonbut never tagged and pushed is invisible to every user, they are told they are up to date.
Edit a release, never delete it. The installers are attached to the release itself, not to the tag. A release that is deleted and made again comes back with an empty Assets list even though the tag still exists, that is how v5.0.0 lost its downloads (issue #32). To change the title or the notes, use Edit on the release; the installers stay put.
A saved draft does not ship by itself. Saving a draft creates no tag, so nothing runs. Publish it, or push the tag: the workflow then finds the draft, adds the install instructions, attaches the installers and publishes it once they are all there. Two saved drafts for one tag stop the run until you delete one.
If a release has no installers (an empty Assets list): Actions → Build & Release → Run workflow, leave Use workflow from at main, type the tag (for example v5.0.0) into the box, Run workflow. A few minutes later the installers are rebuilt from that tag and attached. Your notes are kept, the install instructions are added under them only if they are missing. Leave the box empty for a test build of main, the installers are saved as zip files under Artifacts at the bottom of the run's page, and no release is touched.