Files
punktfunk/docs-site/content/docs/channels.md
T
enricobuehler 4de543c146 ci(release): derive canary version from git tags (single source of truth)
Every release workflow hardcoded a canary base version (0.5.0 in
Apple/Android/rpm/flatpak/deb, 0.3 in windows-msix/windows-host/decky) that
had to be hand-bumped on each stable release and wasn't. With stable at
v0.6.0, every canary was a version *behind* stable — e.g. the Apple canary
showed up on TestFlight as 0.5.0 while 0.6.0 was already published.

Add scripts/ci/pf-version.{sh,ps1} (bash + pwsh twin) as the single source of
truth: stable = the vX.Y.Z tag; canary = latest stable tag with minor+1,
patch 0 (v0.6.0 -> 0.7.0), so canary is always exactly one minor ahead of the
newest release with zero maintenance. Falls back to the workspace Cargo.toml
version when no tag is fetchable. All workflows now eval/call it and format
their own channel suffix off $PF_BASE; only the canary branch changed, stable
branches and per-channel suffixes are untouched. channels.md drops the old
manual "bump the canary base" release step.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-03 22:40:25 +00:00

6.7 KiB

title, description
title description
Release Channels How punktfunk ships — the canary (every main push) and stable (vX.Y.Z) tracks, how to subscribe to each, and how to cut a release.

punktfunk ships on two tracks. Every push to main publishes a canary build to the canary channels (fast iteration, possibly broken). A vX.Y.Z git tag cuts a stable release: every platform is built at that one version, published to the stable channels, and all the artifacts (.deb, .rpm, .msix, host installer, .apk/.aab, .dmg, flatpak, Decky zip) are attached to a single Gitea Release.

The two tracks are separate repos / tracks per platform, never a shared version line — so a stable box never gets pulled onto a canary build, and a canary box always moves forward. Pick the track per machine; switching is a one-line change.

Which track should I be on?

  • Canary — dev boxes, your own test fleet, "I want the latest main build." Updates land minutes after a merge.
  • Stable — anything you don't want to babysit. Only moves when a vX.Y.Z tag is cut.

Subscribe — per platform

Platform Canary Stable
apt (host/client) deb [signed-by=…] https://git.unom.io/api/packages/unom/debian canary main … debian stable main
rpm (host) baseurl …/rpm/bazzite-canary (or fedora-44-canary) …/rpm/bazzite (or fedora-44)
Flatpak (client) flatpak install --user https://flatpak.unom.io/io.unom.Punktfunk.Canary.flatpakref …/io.unom.Punktfunk.flatpakref
Decky (Steam Deck) install-from-URL …/generic/punktfunk-decky/canary/punktfunk.zip …/punktfunk-decky/latest/punktfunk.zip
Windows client (MSIX) …/generic/punktfunk-client-windows/canary/punktfunk-client-windows_x64.msix …/latest/… + the release page
Windows host (installer) …/generic/punktfunk-host-windows/canary/punktfunk-host-setup.exe …/latest/… + the release page
Android Play Internal testing + sideload …/generic/punktfunk-android/canary/punktfunk-android.apk Play closed (alpha) track + the release page
Apple (mac/iOS/tvOS) TestFlight TestFlight + a notarized .dmg on the release page

The apt distribution and the rpm group are just path segments in the URL — switching tracks is a one-line edit of /etc/apt/sources.list.d/punktfunk.list (stablecanary) or /etc/yum.repos.d/punktfunk.repo (…/rpm/bazzite…/rpm/bazzite-canary), then apt update / rpm-ostree upgrade.

The OS-package channels (apt/rpm) are how Linux hosts get canary builds — they are not attached to a canary release page. The Gitea Releases page is stable-only.

Cut a stable release (maintainer)

  1. Make sure main is green.
  2. (Optional) bump any user-facing version that isn't derived from the tag — the Android versionName fallback (clients/android/app/build.gradle.kts) is a cosmetic self-reported string; everything else (binaries via PUNKTFUNK_BUILD_VERSION, MSIX, apt/rpm, the .dmg, and the Decky plugin version — CI stamps it into package.json, where it drives the plugin's own self-update check) derives from the tag automatically.
  3. Tag and push — one tag releases every platform:
    git tag v0.2.0
    git push origin v0.2.0
    
  4. Every platform workflow fans out, builds at 0.2.0, publishes to its stable channel, and attaches its artifact to the v0.2.0 Gitea Release. Concurrent attaches are safe — the shared scripts/ci/gitea-release.{sh,ps1} helper creates the release once and the rest reuse it.
  5. Promote the app stores manually (CI only uploads to testing tracks — see below).

That's the whole ritual: push a tag, done. There is nothing else to hand-edit.

Versioning is derived — never hand-edited

Every workflow gets its version number from one place, scripts/ci/pf-version.{sh,ps1} (the pwsh twin is for the Windows runners), so the number can never drift out of sync:

  • stable (a vX.Y.Z tag) → the tag version (-rc/+meta dropped where a strictly-numeric version is required — MSIX, the App Store marketing version).
  • canary (a main push) → exactly one minor ahead of the latest stable tag (latest v0.6.0 → canary base 0.7.0), with each channel's own build suffix (-ciN, ~ciN, <major>.<minor>.<run>, …). Cutting v0.7.0 automatically advances canary to 0.8.0 on the next main push.

This means canary is always ahead of stable with zero maintenance — the old footgun where a canary showed up on TestFlight as 0.5.0 while 0.6.0 was already published is structurally impossible now. If you ever need the next release to be something other than the next minor (a major bump, or a patch), just tag it — the canary base re-derives from whatever the latest tag is.

Pre-release tags work too: v0.2.0-rc1 builds a real release (the -rc1 suffix is dropped where a strictly-numeric version is required — MSIX, the App Store marketing version).

App-store promotion (manual, after the tag)

CI uploads stable to testing tracks only — it never auto-publishes to the public stores:

  • Apple — the build lands in TestFlight. Promote to the App Store from App Store Connect (submit for review). The notarized .dmg on the release page is the direct-download path.
  • Android — the build lands in Play's closed (alpha) track. Promote alpha → production in the Play Console when ready.

Why two tracks (the version-shadow trap)

apt/rpm/registries serve the highest version to every subscriber. If a stable release landed in the same channel as rolling main builds, every box would jump to it and get stuck — the rolling 0.3.0~ciN build never climbs above a 0.3.0 release. Separate canary/stable channels remove the trap by construction, which is why a single vX.Y.Z tag can safely release the whole project at once (the old host-v* / win-v* / host-win-v* tag namespaces are retired — v* is the only release tag now).

Migrating an existing box to canary

Boxes added before this split point at the current stable channels, which now only move on releases. Point your dev fleet at canary:

# apt
sudo sed -i 's/ stable main/ canary main/' /etc/apt/sources.list.d/punktfunk.list
sudo apt update && sudo apt upgrade

# rpm-ostree (Bazzite / Fedora)
sudo sed -i 's#/rpm/bazzite#/rpm/bazzite-canary#' /etc/yum.repos.d/punktfunk.repo   # or fedora-44 → fedora-44-canary
rpm-ostree upgrade

# Flatpak (Steam Deck client)
flatpak install --user https://flatpak.unom.io/io.unom.Punktfunk.Canary.flatpakref