How to publish a release

This guide shows how to publish a Sidekicks release from a Mac: build every package, tag, attach the files to the release that Rickub creates. It assumes the development tools of How to develop the application, Docker Desktop running, brew install makensis zip, and the right to push tags. RELEASING.md is the same procedure as a checklist.

Steps

Set the version in build/config.yml (info.version), run wails3 task common:update:build-assets, put LSMinimumSystemVersion back to 13.0.0 in build/darwin/Info.plist and Info.dev.plist, then commit, merge into main and git checkout main && git pull.
Build everything: make release-build. dist/ then holds the macOS packages (universal .dmg and .zip), the Windows ones (installer and .zip), the Linux amd64 ones (.deb, .rpm, .AppImage, .tar.gz, built in Docker) and SHA256SUMS.
Tag: make release-tag. The tag v<version> is pushed, and the Release workflow creates the release on Rickub with notes listing the files.
Attach the files: on Rickub, open Releases → v and attach every file of dist/.

Variants

Linux arm64 too: LINUX_ARCHES="amd64 arm64" make release-build.
Leave a system out: SKIP="linux" (or macos, windows, several separated by spaces) before make release-build.
Tag without pushing: scripts/tag-release.sh --no-push, then git push origin v<version> when ready.
Wrong tag: git push origin :refs/tags/v<version> and git tag -d v<version>, delete the release if it was created, fix the version and tag again.
One package only: make package-macos, make package-windows or make package-linux (Linux only, for the machine's architecture).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


# How to publish a release

This guide shows how to publish a Sidekicks release from a Mac: build every package, tag, attach the files to the release that Rickub creates. It assumes the development tools of [How to develop the application](develop-the-application.md), Docker Desktop running, `brew install makensis zip`, and the right to push tags. [RELEASING.md](../../../RELEASING.md) is the same procedure as a checklist.

## Steps

1. **Set the version** in `build/config.yml` (`info.version`), run `wails3 task common:update:build-assets`, put `LSMinimumSystemVersion` back to `13.0.0` in `build/darwin/Info.plist` and `Info.dev.plist`, then commit, merge into `main` and `git checkout main && git pull`.
2. **Build everything**: `make release-build`. `dist/` then holds the macOS packages (universal `.dmg` and `.zip`), the Windows ones (installer and `.zip`), the Linux amd64 ones (`.deb`, `.rpm`, `.AppImage`, `.tar.gz`, built in Docker) and `SHA256SUMS`.
3. **Tag**: `make release-tag`. The tag `v<version>` is pushed, and the **Release** workflow creates the release on Rickub with notes listing the files.
4. **Attach the files**: on Rickub, open **Releases → v<version>** and attach every file of `dist/`.

## Variants

- **Linux arm64 too**: `LINUX_ARCHES="amd64 arm64" make release-build`.
- **Leave a system out**: `SKIP="linux"` (or `macos`, `windows`, several separated by spaces) before `make release-build`.
- **Tag without pushing**: `scripts/tag-release.sh --no-push`, then `git push origin v<version>` when ready.
- **Wrong tag**: `git push origin :refs/tags/v<version>` and `git tag -d v<version>`, delete the release if it was created, fix the version and tag again.
- **One package only**: `make package-macos`, `make package-windows` or `make package-linux` (Linux only, for the machine's architecture).

## See also

- [How to install Sidekicks](install-sidekicks.md)
- [Reference: commands](../reference/commands.md) — `make release-*`, `scripts/build-release.sh`, `scripts/tag-release.sh`, the Release workflow