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, brew install makensis, 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 (.dmg and .zip for Apple Silicon), the Windows ones (installer and .zip, for x86-64 and for Arm) 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/.
Fetch the tag in every other copy of the repository (another machine, a sandbox): git fetch --tags, then git tag --list 'v*' shows v<version>.

Variants

Linux packages too (not released for now): LINUX_ARCHES=amd64 make release-build, with Docker Desktop running.
Leave a system out: SKIP="windows" (or macos) before make release-build; WINDOWS_ARCHES=amd64 for one Windows architecture.
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 system only: make package-macos, make package-windows (both architectures) or make package-linux (on Linux, 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
24
25


# 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), `brew install makensis`, 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 (`.dmg` and `.zip` for Apple Silicon), the Windows ones (installer and `.zip`, for x86-64 and for Arm) 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/`.
5. **Fetch the tag** in every other copy of the repository (another machine, a sandbox): `git fetch --tags`, then `git tag --list 'v*'` shows `v<version>`.

## Variants

- **Linux packages too** (not released for now): `LINUX_ARCHES=amd64 make release-build`, with Docker Desktop running.
- **Leave a system out**: `SKIP="windows"` (or `macos`) before `make release-build`; `WINDOWS_ARCHES=amd64` for one Windows architecture.
- **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 system only**: `make package-macos`, `make package-windows` (both architectures) or `make package-linux` (on Linux, for the machine's architecture).

## See also

- [How to sign and notarize Sidekicks for macOS](sign-and-notarize-on-macos.md)
- [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