7 Commits

Author SHA1 Message Date
Micha
ace1a008ef chore: release 26.0.26 2025-11-26 20:18:06 +01:00
Micha
354488d623 more Sparkle tests 2025-11-26 20:16:34 +01:00
Micha
61392a16a2 more Sparkle tests 2025-11-26 20:14:59 +01:00
Micha
d46e0450bf more Sparkle tests 2025-11-26 20:11:32 +01:00
Micha
5905ae5aa7 more Sparkle tests 2025-11-26 20:09:06 +01:00
Micha
9a6609df7b chore: release 26.0.22 2025-11-26 18:54:55 +01:00
Micha
eadd8e9d28 more Sparkle tests 2025-11-26 18:53:14 +01:00
8 changed files with 97 additions and 58 deletions

View File

@@ -5,5 +5,5 @@
add a marker for "reboot required" add a marker for "reboot required"
dummy2 dummy22

View File

@@ -59,8 +59,7 @@ 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_URL="https://git.24unix.net/tracer/iKeyMon/releases/download" # SPARKLE_DOWNLOAD_BASE_TEMPLATE="https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}"
# SPARKLE_DOWNLOAD_VERSION_PREFIX="v" # optional
# SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # default # SPARKLE_APPCAST_OUTPUT="$ROOT_DIR/Sparkle/appcast.xml" # default
``` ```
@@ -73,15 +72,25 @@ 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 Sparkles `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 your release-download root (e.g. `https://git.24unix.net/tracer/iKeyMon/releases/download`) and, if your host groups assets under versioned folders, set `SPARKLE_DOWNLOAD_VERSION_PREFIX` (defaults to `v`, producing URLs like `/download/v26.0.20/...`). The feed stays inside the repo (it is not uploaded as a release asset). 2. `./scripts/build_release.sh` signs the ZIP with Sparkles `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 already match Giteas asset paths. 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 Sparkles built-in toggles for “Automatically check” and “Automatically download”, and the toolbar button simply calls Sparkles “Check for Updates…” sheet. Preferences expose Sparkles built-in toggles for “Automatically check” and “Automatically download”, and the toolbar button simply calls Sparkles “Check for Updates…” sheet.
> `./scripts/build_release.sh` will call `generate_appcast` for you when `SPARKLE_EDDSA_KEY_FILE` and either `SPARKLE_DOWNLOAD_BASE_URL` (optionally with `SPARKLE_DOWNLOAD_VERSION_PREFIX`) or `SPARKLE_DOWNLOAD_BASE_TEMPLATE` are set. It tries to locate Sparkles 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 `SPARKLE_DOWNLOAD_BASE_TEMPLATE` (or `SPARKLE_DOWNLOAD_BASE_URL`) are set. It tries to locate Sparkles 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.
#### Debugging Sparkle updates
Launch the shipped app via CLI with `SPARKLE_VERBOSE_LOGGING=1` to mirror Sparkles activity in stdout/stderr:
```bash
SPARKLE_VERBOSE_LOGGING=1 /Applications/iKeyMon.app/Contents/MacOS/iKeyMon
```
Sparkles installer helper runs in a separate `SUPipedBinary` process. If the installer fails, collect additional details with `log show --process SUPipedBinary --last 5m`.
### Automated release push ### Automated release push
If you want `git push origin master` to build/sign/notarize/upload automatically, enable the provided pre-push hook: If you want `git push origin master` to build/sign/notarize/upload automatically, enable the provided pre-push hook:

View File

@@ -1,13 +1,20 @@
import Sparkle import Sparkle
import Foundation import Foundation
import OSLog
@MainActor @MainActor
final class SparkleUpdater: NSObject, ObservableObject { final class SparkleUpdater: NSObject, ObservableObject {
let controller: SPUStandardUpdaterController private lazy var controller: SPUStandardUpdaterController = {
SPUStandardUpdaterController(startingUpdater: true, updaterDelegate: self, userDriverDelegate: nil)
}()
private let logger = Logger(subsystem: "net.24unix.iKeyMon", category: "Sparkle")
private let verboseLogging: Bool
override init() { override init() {
self.controller = SPUStandardUpdaterController(startingUpdater: true, updaterDelegate: nil, userDriverDelegate: nil) self.verboseLogging = ProcessInfo.processInfo.environment["SPARKLE_VERBOSE_LOGGING"] == "1"
super.init() super.init()
_ = controller
log("Sparkle updater initialized (verbose=\(verboseLogging)).")
} }
var automaticallyChecksForUpdates: Bool { var automaticallyChecksForUpdates: Bool {
@@ -21,6 +28,66 @@ final class SparkleUpdater: NSObject, ObservableObject {
} }
func checkForUpdates() { func checkForUpdates() {
log("Manual check for updates triggered.")
controller.checkForUpdates(nil) controller.checkForUpdates(nil)
} }
private func log(_ message: String) {
logger.log("\(message, privacy: .public)")
if verboseLogging {
print("[Sparkle] \(message)")
}
}
private func logError(_ message: String) {
logger.error("\(message, privacy: .public)")
if verboseLogging {
fputs("[Sparkle][error] \(message)\n", stderr)
}
}
private func describe(update item: SUAppcastItem) -> String {
let short = item.displayVersionString
let build = item.versionString
return "\(short) (build \(build))"
}
}
@MainActor
extension SparkleUpdater: SPUUpdaterDelegate {
func updater(_ updater: SPUUpdater, didFinishLoading appcast: SUAppcast) {
log("Loaded Sparkle appcast containing \(appcast.items.count) item(s).")
}
func updater(_ updater: SPUUpdater, didFindValidUpdate item: SUAppcastItem) {
log("Found valid update \(describe(update: item))")
}
func updaterDidNotFindUpdate(_ updater: SPUUpdater) {
log("No updates available.")
}
func updater(_ updater: SPUUpdater, willDownloadUpdate item: SUAppcastItem, with request: NSMutableURLRequest) {
log("Downloading \(describe(update: item)) from \(request.url?.absoluteString ?? "unknown URL")")
}
func updater(_ updater: SPUUpdater, didDownloadUpdate item: SUAppcastItem) {
log("Finished downloading \(describe(update: item))")
}
func updater(_ updater: SPUUpdater, failedToDownloadUpdate item: SUAppcastItem, error: Error) {
logError("Failed to download \(describe(update: item)): \(error.localizedDescription)")
}
func userDidCancelDownload(_ updater: SPUUpdater) {
log("User cancelled Sparkle download.")
}
func updater(_ updater: SPUUpdater, willInstallUpdate item: SUAppcastItem) {
log("Will install update \(describe(update: item))")
}
func updater(_ updater: SPUUpdater, didAbortWithError error: Error) {
logError("Sparkle aborted: \(error.localizedDescription)")
}
} }

2
Sparkle/appcast.xml vendored
View File

@@ -8,7 +8,7 @@
<ns0:version>49</ns0:version> <ns0:version>49</ns0:version>
<ns0:shortVersionString>26.0.21</ns0:shortVersionString> <ns0:shortVersionString>26.0.21</ns0:shortVersionString>
<ns0:minimumSystemVersion>15.2</ns0:minimumSystemVersion> <ns0:minimumSystemVersion>15.2</ns0:minimumSystemVersion>
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/iKeyMon-26.0.21.zip" length="4802995" type="application/octet-stream" ns0:edSignature="bYXN15YyKlSmHKNXPizEW2WrVXQSgD5XOgbtzOYNL+maG8DB/jZ08A+cYtGgqUeSRd+X6Z5Ue+Tpdn4/ewsFBw==" /> <enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.21/iKeyMon-26.0.21.zip" length="4802995" type="application/octet-stream" ns0:edSignature="bYXN15YyKlSmHKNXPizEW2WrVXQSgD5XOgbtzOYNL+maG8DB/jZ08A+cYtGgqUeSRd+X6Z5Ue+Tpdn4/ewsFBw==" />
</item> </item>
<item> <item>
<title>26.0.20</title> <title>26.0.20</title>

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 = 49; CURRENT_PROJECT_VERSION = 56;
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\""; DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
DEVELOPMENT_TEAM = Q5486ZVAFT; DEVELOPMENT_TEAM = Q5486ZVAFT;
ENABLE_HARDENED_RUNTIME = YES; ENABLE_HARDENED_RUNTIME = YES;
@@ -325,7 +325,7 @@
"$(inherited)", "$(inherited)",
"@executable_path/../Frameworks", "@executable_path/../Frameworks",
); );
MARKETING_VERSION = 26.0.21; MARKETING_VERSION = 26.0.26;
PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon; PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon;
PRODUCT_NAME = "$(TARGET_NAME)"; PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_EMIT_LOC_STRINGS = YES; SWIFT_EMIT_LOC_STRINGS = 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 = 49; CURRENT_PROJECT_VERSION = 56;
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\""; DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
DEVELOPMENT_TEAM = Q5486ZVAFT; DEVELOPMENT_TEAM = Q5486ZVAFT;
ENABLE_HARDENED_RUNTIME = YES; ENABLE_HARDENED_RUNTIME = YES;
@@ -356,7 +356,7 @@
"$(inherited)", "$(inherited)",
"@executable_path/../Frameworks", "@executable_path/../Frameworks",
); );
MARKETING_VERSION = 26.0.21; MARKETING_VERSION = 26.0.26;
PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon; PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon;
PRODUCT_NAME = "$(TARGET_NAME)"; PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_EMIT_LOC_STRINGS = YES; SWIFT_EMIT_LOC_STRINGS = YES;

View File

@@ -29,8 +29,12 @@ find_generate_appcast() {
generate_appcast() { generate_appcast() {
local generator local generator
generator="$(find_generate_appcast)" generator="$(find_generate_appcast)"
local download_prefix="${SPARKLE_DOWNLOAD_BASE_URL:-}" local download_prefix=""
local version_prefix="${SPARKLE_DOWNLOAD_VERSION_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 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)."
@@ -57,7 +61,6 @@ generate_appcast() {
"$staging_dir"; then "$staging_dir"; then
echo "⚠️ Sparkle appcast generation failed." echo "⚠️ Sparkle appcast generation failed."
fi fi
rewrite_appcast_urls "$output" "$version_prefix"
rm -rf "$staging_dir" rm -rf "$staging_dir"
} }
@@ -75,46 +78,7 @@ sign_update_artifacts() {
} }
rewrite_appcast_urls() { rewrite_appcast_urls() {
local appcast="$1" : # no-op (old helper removed)
local version_prefix="$2"
local marker="${SPARKLE_DOWNLOAD_VERSION_MARKER:-/releases/download/}"
if [[ -z "$version_prefix" || -z "$marker" ]]; then
return
fi
python3 - "$appcast" "$marker" "$version_prefix" <<'PY'
import sys
import xml.etree.ElementTree as ET
path, marker, prefix = sys.argv[1:]
tree = ET.parse(path)
root = tree.getroot()
ns = {'sparkle': 'http://www.andymatuschak.org/xml-namespaces/sparkle'}
changed = False
for item in root.findall('.//item'):
short = item.find('sparkle:shortVersionString', ns)
enclosure = item.find('enclosure')
if short is None or enclosure is None:
continue
version = (short.text or '').strip()
url = enclosure.get('url')
if not version or not url or marker not in url:
continue
desired = f"{marker}{prefix}{version}/"
if desired in url:
continue
base, rest = url.split(marker, 1)
if rest.startswith(f"{prefix}{version}/"):
continue
new_rest = f"{prefix}{version}/{rest.lstrip('/')}"
enclosure.set('url', f"{base}{marker}{new_rest}")
changed = True
if changed:
ET.indent(tree, space=" ", level=0)
tree.write(path, encoding='utf-8', xml_declaration=True)
PY
} }
submit_for_notarization() { submit_for_notarization() {

View File

@@ -11,7 +11,6 @@ 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_URL="https://git.24unix.net/tracer/iKeyMon/releases/download" # SPARKLE_DOWNLOAD_BASE_TEMPLATE="https://git.24unix.net/tracer/iKeyMon/releases/download/v{{VERSION}}"
# SPARKLE_DOWNLOAD_VERSION_PREFIX="v" # prepended before each short version in URLs
# 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

View File

@@ -1,3 +1,3 @@
{ {
"marketing_version": "26.0.21" "marketing_version": "26.0.26"
} }