tracer/iKeyMon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

more Sparkle tests

Browse Source
This commit is contained in:
Micha
2025-11-25 19:03:05 +01:00
parent 57dc68f434
commit d65ec99cfb
5 changed files with 52 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -59,7 +59,8 @@ GITEA_REPO="iKeyMon"
# optional: GITEA_PRERELEASE="false" # defaults to true until preferences are done # optional: GITEA_PRERELEASE="false" # defaults to true until preferences are done
# optional Sparkle feed helpers: # optional Sparkle feed helpers:
# SPARKLE_EDDSA_KEY_FILE="$HOME/.config/Sparkle/iKeyMon.key" # SPARKLE_EDDSA_KEY_FILE="$HOME/.config/Sparkle/iKeyMon.key"
# SPARKLE_DOWNLOAD_BASE_TEMPLATE="https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}" # SPARKLE_DOWNLOAD_BASE_URL="https://git.24unix.net/tracer/iKeyMon/releases/download"
# SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE="v{{VERSION}}"
# SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # default # SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # default
``` ```
@@ -72,12 +73,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. 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). 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. Point `SPARKLE_DOWNLOAD_BASE_TEMPLATE` at your release download prefix to ensure the feed URLs resolve correctly. 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. 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).
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`). 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. 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` 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`). > `./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`).
> 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. > 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.

6
Sparkle/appcast.xml vendored
View File

@@ -8,7 +8,7 @@
<sparkle:version>39</sparkle:version> <sparkle:version>39</sparkle:version>
<sparkle:shortVersionString>26.0.16</sparkle:shortVersionString> <sparkle:shortVersionString>26.0.16</sparkle:shortVersionString>
<sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion> <sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion>
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/iKeyMon-26.0.16.zip" length="4801351" type="application/octet-stream" sparkle:edSignature="lbQEpxEElRxwyRdm0LQIxsnfh8o8Kt66wQlcl4PBs68lBmjkq0b/5EsVCElWQb0Nei/GCk6I/m2mSNL7mA3wBQ=="/> <enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.16/iKeyMon-26.0.16.zip" length="4801351" type="application/octet-stream" sparkle:edSignature="lbQEpxEElRxwyRdm0LQIxsnfh8o8Kt66wQlcl4PBs68lBmjkq0b/5EsVCElWQb0Nei/GCk6I/m2mSNL7mA3wBQ=="/>
</item> </item>
<item> <item>
<title>26.0.15</title> <title>26.0.15</title>
@@ -16,7 +16,7 @@
<sparkle:version>35</sparkle:version> <sparkle:version>35</sparkle:version>
<sparkle:shortVersionString>26.0.15</sparkle:shortVersionString> <sparkle:shortVersionString>26.0.15</sparkle:shortVersionString>
<sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion> <sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion>
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/iKeyMon-26.0.15.zip" length="4801128" type="application/octet-stream" sparkle:edSignature="T16+tX44yN2UqIUsMJeZAxydOuLC6lcQQrlRElTkJlSWPheWLy9xPjP4T45mNSOcWTax0gRCnI50ab3geL9XAA=="/> <enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.15/iKeyMon-26.0.15.zip" length="4801128" type="application/octet-stream" sparkle:edSignature="T16+tX44yN2UqIUsMJeZAxydOuLC6lcQQrlRElTkJlSWPheWLy9xPjP4T45mNSOcWTax0gRCnI50ab3geL9XAA=="/>
</item> </item>
<item> <item>
<title>26.0.15</title> <title>26.0.15</title>
@@ -24,7 +24,7 @@
<sparkle:version>34</sparkle:version> <sparkle:version>34</sparkle:version>
<sparkle:shortVersionString>26.0.15</sparkle:shortVersionString> <sparkle:shortVersionString>26.0.15</sparkle:shortVersionString>
<sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion> <sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion>
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/iKeyMon-26.0.15.zip" length="4800821" type="application/octet-stream" sparkle:edSignature="bojJ638CY0n+34POoJX3OBrXRAiPOYPiDTfgJOS9fCslw8YGKZLviJvcExC2PKh1HDt0Raabo0FJUJrAFUMmBQ=="/> <enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.15/iKeyMon-26.0.15.zip" length="4800821" type="application/octet-stream" sparkle:edSignature="bojJ638CY0n+34POoJX3OBrXRAiPOYPiDTfgJOS9fCslw8YGKZLviJvcExC2PKh1HDt0Raabo0FJUJrAFUMmBQ=="/>
</item> </item>
</channel> </channel>
</rss> </rss>

4
iKeyMon.xcodeproj/project.pbxproj
View File

@@ -310,7 +310,7 @@
CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements; CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements;
CODE_SIGN_STYLE = Automatic; CODE_SIGN_STYLE = Automatic;
COMBINE_HIDPI_IMAGES = YES; COMBINE_HIDPI_IMAGES = YES;
CURRENT_PROJECT_VERSION = 39; CURRENT_PROJECT_VERSION = 40;
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\""; DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
DEVELOPMENT_TEAM = Q5486ZVAFT; DEVELOPMENT_TEAM = Q5486ZVAFT;
ENABLE_HARDENED_RUNTIME = YES; ENABLE_HARDENED_RUNTIME = YES;
@@ -341,7 +341,7 @@
CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements; CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements;
CODE_SIGN_STYLE = Automatic; CODE_SIGN_STYLE = Automatic;
COMBINE_HIDPI_IMAGES = YES; COMBINE_HIDPI_IMAGES = YES;
CURRENT_PROJECT_VERSION = 39; CURRENT_PROJECT_VERSION = 40;
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\""; DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
DEVELOPMENT_TEAM = Q5486ZVAFT; DEVELOPMENT_TEAM = Q5486ZVAFT;
ENABLE_HARDENED_RUNTIME = YES; ENABLE_HARDENED_RUNTIME = YES;

47
scripts/build_release.sh
View File

@@ -29,23 +29,56 @@ find_generate_appcast() {
generate_appcast() { generate_appcast() {
local generator local generator
generator="$(find_generate_appcast)" generator="$(find_generate_appcast)"
local download_prefix="" local download_prefix="${SPARKLE_DOWNLOAD_BASE_URL:-}"
if [[ -n "${SPARKLE_DOWNLOAD_BASE_TEMPLATE:-}" ]]; then local subdir_template="${SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE:-}"
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 if [[ -z "$generator" || -z "${SPARKLE_EDDSA_KEY_FILE:-}" || -z "$download_prefix" ]]; then
echo "ℹ️ Skipping Sparkle appcast generation (generator/key/download prefix not configured)." echo "ℹ️ Skipping Sparkle appcast generation (generator/key/download prefix not configured)."
return return
fi fi
download_prefix="${download_prefix%/}"
local output="$SPARKLE_APPCAST_OUTPUT" local output="$SPARKLE_APPCAST_OUTPUT"
mkdir -p "$(dirname "$output")" mkdir -p "$(dirname "$output")"
local staging_dir local staging_dir
staging_dir="$(mktemp -d)" staging_dir="$(mktemp -d)"
cp "$ARTIFACTS_DIR"/*.zip "$staging_dir"/ 2>/dev/null || true 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
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
echo "ℹ️ Skipping Sparkle appcast generation (no ZIP archives found)."
rm -rf "$staging_dir"
return
fi
echo "🧾 Generating Sparkle appcast at $output" echo "🧾 Generating Sparkle appcast at $output"
if ! "$generator" \ if ! "$generator" \
--download-url-prefix "$download_prefix" \ --download-url-prefix "$download_prefix" \

3
signing.env.example
View File

@@ -11,6 +11,7 @@ GITEA_REPO="iKeyMon"
# Sparkle appcast generation (optional) # Sparkle appcast generation (optional)
# SPARKLE_EDDSA_KEY_FILE="$HOME/.config/Sparkle/iKeyMon.key" # SPARKLE_EDDSA_KEY_FILE="$HOME/.config/Sparkle/iKeyMon.key"
# SPARKLE_DOWNLOAD_BASE_TEMPLATE="https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}" # SPARKLE_DOWNLOAD_BASE_URL="https://git.24unix.net/tracer/iKeyMon/releases/download"
# SPARKLE_DOWNLOAD_SUBDIR_TEMPLATE="v{{VERSION}}"
# SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # defaults to this path # SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # defaults to this path
# SPARKLE_GENERATE_APPCAST="/path/to/generate_appcast" # auto-detected if unset # SPARKLE_GENERATE_APPCAST="/path/to/generate_appcast" # auto-detected if unset