From 0d013e64f7459bd1d8f52d40ebf8e7f5788d7a28 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 26 Nov 2025 18:35:05 +0100 Subject: [PATCH] more Sparkle tests --- README.md | 7 +++---- scripts/build_release.sh | 42 ++++++++-------------------------------- signing.env.example | 3 +-- 3 files changed, 12 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 16c27ad..c179549 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,7 @@ GITEA_REPO="iKeyMon" # optional: GITEA_PRERELEASE="false" # defaults to true until preferences are done # optional Sparkle feed helpers: # SPARKLE_EDDSA_KEY_FILE="$HOME/.config/Sparkle/iKeyMon.key" -# SPARKLE_DOWNLOAD_BASE_URL="https://git.24unix.net/tracer/iKeyMon/releases/download" -# SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE="v{{VERSION}}" +# SPARKLE_DOWNLOAD_BASE_TEMPLATE="https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}" # SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # default ``` @@ -73,12 +72,12 @@ If you re-run the release script for the same version, it removes any existing a iKeyMon uses [Sparkle](https://sparkle-project.org/) for macOS-safe updates. 1. Generate an EdDSA key pair once (`./Packages/Sparkle/bin/generate_keys`). Store the private key on-disk (for example `~/.config/Sparkle/iKeyMon.key`, which the build script expects) and copy the public key into the `SUPublicEDKey` entry (see Info.plist notes below). -2. `./scripts/build_release.sh` signs the ZIP with Sparkle’s `sign_update` tool and invokes `generate_appcast` automatically when the Sparkle variables are present. The generated feed is written to `Sparkle/appcast.xml`, so commit that file after every release. Set `SPARKLE_DOWNLOAD_BASE_URL` to the static portion of your release-download endpoint (e.g. `https://…/releases/download`) and `SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE` to the path segment that should be inserted before each asset (default `v{{VERSION}}` mirrors how Gitea exposes assets). The feed stays inside the repo (it is not uploaded as a release asset). +2. `./scripts/build_release.sh` signs the ZIP with Sparkle’s `sign_update` tool and invokes `generate_appcast` automatically when the Sparkle variables are present. The generated feed is written to `Sparkle/appcast.xml`, so commit that file after every release. Point `SPARKLE_DOWNLOAD_BASE_TEMPLATE` at your release-download prefix (e.g. `https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}`) so the generated URLs match where Gitea serves assets. The feed stays inside the repo (it is not uploaded as a release asset). 3. Set `SUFeedURL` in Info.plist (or the corresponding build setting) to the raw URL of `Sparkle/appcast.xml` inside this repo (e.g. `https://git.24unix.net/tracer/iKeyMon/raw/branch/master/Sparkle/appcast.xml`). Preferences expose Sparkle’s built-in toggles for “Automatically check” and “Automatically download”, and the toolbar button simply calls Sparkle’s “Check for Updates…” sheet. -> `./scripts/build_release.sh` will call `generate_appcast` for you when `SPARKLE_EDDSA_KEY_FILE`, `SPARKLE_DOWNLOAD_BASE_URL`, and (optionally) `SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE` are set. It tries to locate Sparkle’s CLI in DerivedData automatically, but you can override the path via `SPARKLE_GENERATE_APPCAST`. The resulting feed is written to `SPARKLE_APPCAST_OUTPUT` (defaults to `Sparkle/appcast.xml`). +> `./scripts/build_release.sh` will call `generate_appcast` for you when `SPARKLE_EDDSA_KEY_FILE` and either `SPARKLE_DOWNLOAD_BASE_TEMPLATE` (with `{{VERSION}}` placeholder) or `SPARKLE_DOWNLOAD_BASE_URL` are set. It tries to locate Sparkle’s CLI in DerivedData automatically, but you can override the path via `SPARKLE_GENERATE_APPCAST`. The resulting feed is written to `SPARKLE_APPCAST_OUTPUT` (defaults to `Sparkle/appcast.xml`). > Build settings include `INFOPLIST_KEY_SUFeedURL` and `INFOPLIST_KEY_SUPublicEDKey`. Make sure to fill both before shipping a build so Sparkle knows where to fetch updates and how to verify them. diff --git a/scripts/build_release.sh b/scripts/build_release.sh index ea8c851..b67c9ab 100755 --- a/scripts/build_release.sh +++ b/scripts/build_release.sh @@ -29,51 +29,25 @@ find_generate_appcast() { generate_appcast() { local generator generator="$(find_generate_appcast)" - local download_prefix="${SPARKLE_DOWNLOAD_BASE_URL:-}" - local subdir_template="${SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE:-}" + local download_prefix="" + if [[ -n "${SPARKLE_DOWNLOAD_BASE_TEMPLATE:-}" ]]; then + download_prefix="${SPARKLE_DOWNLOAD_BASE_TEMPLATE//\{\{VERSION\}\}/$VERSION}" + else + download_prefix="${SPARKLE_DOWNLOAD_BASE_URL:-}" + fi if [[ -z "$generator" || -z "${SPARKLE_EDDSA_KEY_FILE:-}" || -z "$download_prefix" ]]; then echo "ℹ️ Skipping Sparkle appcast generation (generator/key/download prefix not configured)." return fi - download_prefix="${download_prefix%/}" local output="$SPARKLE_APPCAST_OUTPUT" mkdir -p "$(dirname "$output")" - local staging_dir staging_dir="$(mktemp -d)" - local zip_found=false - shopt -s nullglob - for zip_path in "$ARTIFACTS_DIR"/*.zip; do - zip_found=true - local filename version_guess target_dir subdir - filename="$(basename "$zip_path")" - if [[ "$filename" =~ ([0-9]+\.[0-9]+\.[0-9]+) ]]; then - version_guess="${BASH_REMATCH[1]}" - else - version_guess="$VERSION" - fi + cp "$ARTIFACTS_DIR"/*.zip "$staging_dir"/ 2>/dev/null || true - target_dir="$staging_dir" - if [[ -n "$subdir_template" ]]; then - subdir="$subdir_template" - subdir="${subdir//\{\{VERSION\}\}/$version_guess}" - subdir="${subdir//\{\{SHORT_VERSION\}\}/$version_guess}" - subdir="${subdir//\{\{TAG\}\}/v$version_guess}" - subdir="${subdir#/}" - subdir="${subdir%/}" - if [[ -n "$subdir" ]]; then - target_dir="$staging_dir/$subdir" - mkdir -p "$target_dir" - fi - fi - - cp "$zip_path" "$target_dir/" - done - shopt -u nullglob - - if [[ "$zip_found" != true ]]; then + if ! ls "$staging_dir"/*.zip >/dev/null 2>&1; then echo "ℹ️ Skipping Sparkle appcast generation (no ZIP archives found)." rm -rf "$staging_dir" return diff --git a/signing.env.example b/signing.env.example index ededbfb..24d0a4e 100644 --- a/signing.env.example +++ b/signing.env.example @@ -11,7 +11,6 @@ GITEA_REPO="iKeyMon" # Sparkle appcast generation (optional) # SPARKLE_EDDSA_KEY_FILE="$HOME/.config/Sparkle/iKeyMon.key" -# SPARKLE_DOWNLOAD_BASE_URL="https://git.24unix.net/tracer/iKeyMon/releases/download" -# SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE="v{{VERSION}}" +# SPARKLE_DOWNLOAD_BASE_TEMPLATE="https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}" # SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # defaults to this path # SPARKLE_GENERATE_APPCAST="/path/to/generate_appcast" # auto-detected if unset