Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ace1a008ef | ||
|
|
354488d623 | ||
|
|
61392a16a2 | ||
|
|
d46e0450bf | ||
|
|
5905ae5aa7 | ||
|
|
9a6609df7b | ||
|
|
eadd8e9d28 | ||
|
|
473354a50a | ||
|
|
1945b1dedb | ||
|
|
dc7a516b6d | ||
|
|
0d013e64f7 | ||
|
|
c2cd66d2a3 | ||
|
|
ad50433406 | ||
|
|
fd83208760 | ||
|
|
05017ffd5e | ||
|
|
24794a1d63 | ||
|
|
d65ec99cfb | ||
|
|
57dc68f434 | ||
|
|
e3b14e87fe |
14
README.md
14
README.md
@@ -72,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.
|
||||
|
||||
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. 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 Gitea’s 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`).
|
||||
|
||||
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` and `SPARKLE_DOWNLOAD_BASE_TEMPLATE` (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.
|
||||
|
||||
#### Debugging Sparkle updates
|
||||
|
||||
Launch the shipped app via CLI with `SPARKLE_VERBOSE_LOGGING=1` to mirror Sparkle’s activity in stdout/stderr:
|
||||
|
||||
```bash
|
||||
SPARKLE_VERBOSE_LOGGING=1 /Applications/iKeyMon.app/Contents/MacOS/iKeyMon
|
||||
```
|
||||
|
||||
Sparkle’s 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
|
||||
|
||||
If you want `git push origin master` to build/sign/notarize/upload automatically, enable the provided pre-push hook:
|
||||
|
||||
@@ -1,13 +1,20 @@
|
||||
import Sparkle
|
||||
import Foundation
|
||||
import OSLog
|
||||
|
||||
@MainActor
|
||||
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() {
|
||||
self.controller = SPUStandardUpdaterController(startingUpdater: true, updaterDelegate: nil, userDriverDelegate: nil)
|
||||
self.verboseLogging = ProcessInfo.processInfo.environment["SPARKLE_VERBOSE_LOGGING"] == "1"
|
||||
super.init()
|
||||
_ = controller
|
||||
log("Sparkle updater initialized (verbose=\(verboseLogging)).")
|
||||
}
|
||||
|
||||
var automaticallyChecksForUpdates: Bool {
|
||||
@@ -21,6 +28,66 @@ final class SparkleUpdater: NSObject, ObservableObject {
|
||||
}
|
||||
|
||||
func checkForUpdates() {
|
||||
log("Manual check for updates triggered.")
|
||||
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)")
|
||||
}
|
||||
}
|
||||
|
||||
40
Sparkle/appcast.xml
vendored
40
Sparkle/appcast.xml
vendored
@@ -1,30 +1,30 @@
|
||||
<?xml version="1.0" standalone="yes"?>
|
||||
<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" version="2.0">
|
||||
<?xml version='1.0' encoding='utf-8'?>
|
||||
<rss xmlns:ns0="http://www.andymatuschak.org/xml-namespaces/sparkle" version="2.0">
|
||||
<channel>
|
||||
<title>iKeyMon</title>
|
||||
<item>
|
||||
<title>26.0.15</title>
|
||||
<pubDate>Tue, 25 Nov 2025 18:11:17 +0100</pubDate>
|
||||
<sparkle:version>35</sparkle:version>
|
||||
<sparkle:shortVersionString>26.0.15</sparkle:shortVersionString>
|
||||
<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=="/>
|
||||
<title>26.0.21</title>
|
||||
<pubDate>Wed, 26 Nov 2025 18:44:41 +0100</pubDate>
|
||||
<ns0:version>49</ns0:version>
|
||||
<ns0:shortVersionString>26.0.21</ns0:shortVersionString>
|
||||
<ns0:minimumSystemVersion>15.2</ns0:minimumSystemVersion>
|
||||
<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>
|
||||
<title>26.0.15</title>
|
||||
<pubDate>Tue, 25 Nov 2025 17:42:56 +0100</pubDate>
|
||||
<sparkle:version>34</sparkle:version>
|
||||
<sparkle:shortVersionString>26.0.15</sparkle:shortVersionString>
|
||||
<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=="/>
|
||||
<title>26.0.20</title>
|
||||
<pubDate>Wed, 26 Nov 2025 18:36:41 +0100</pubDate>
|
||||
<ns0:version>47</ns0:version>
|
||||
<ns0:shortVersionString>26.0.20</ns0:shortVersionString>
|
||||
<ns0:minimumSystemVersion>15.2</ns0:minimumSystemVersion>
|
||||
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.20/iKeyMon-26.0.20.zip" length="4802865" type="application/octet-stream" ns0:edSignature="hCJu2I1Db/TaU6pCs1gZi9EO5igr49Fjt/VNnyD8+jm45WINuhzGc4lShcLPxUQTy4iNHnVhmOPYwlthVMXPAg==" />
|
||||
</item>
|
||||
<item>
|
||||
<title>26.0.13</title>
|
||||
<pubDate>Tue, 25 Nov 2025 00:05:46 +0100</pubDate>
|
||||
<sparkle:version>32</sparkle:version>
|
||||
<sparkle:shortVersionString>26.0.13</sparkle:shortVersionString>
|
||||
<sparkle:minimumSystemVersion>15.2</sparkle:minimumSystemVersion>
|
||||
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.13/iKeyMon-26.0.13.zip" length="4800781" type="application/octet-stream" sparkle:edSignature="KIGsFaFftWzENTEOHnpPEtk/WaUicS0xK9yMh7e98OKBxlsBkxfghoTu2xU8ZKlEqM6Ndhr5UQwZJE4uBsELAA=="/>
|
||||
<title>26.0.16</title>
|
||||
<pubDate>Tue, 25 Nov 2025 18:34:19 +0100</pubDate>
|
||||
<ns0:version>39</ns0:version>
|
||||
<ns0:shortVersionString>26.0.16</ns0:shortVersionString>
|
||||
<ns0:minimumSystemVersion>15.2</ns0:minimumSystemVersion>
|
||||
<enclosure url="https://git.24unix.net/tracer/iKeyMon/releases/download/v26.0.16/iKeyMon-26.0.16.zip" length="4801351" type="application/octet-stream" ns0:edSignature="lbQEpxEElRxwyRdm0LQIxsnfh8o8Kt66wQlcl4PBs68lBmjkq0b/5EsVCElWQb0Nei/GCk6I/m2mSNL7mA3wBQ==" />
|
||||
</item>
|
||||
</channel>
|
||||
</rss>
|
||||
@@ -310,7 +310,7 @@
|
||||
CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements;
|
||||
CODE_SIGN_STYLE = Automatic;
|
||||
COMBINE_HIDPI_IMAGES = YES;
|
||||
CURRENT_PROJECT_VERSION = 35;
|
||||
CURRENT_PROJECT_VERSION = 56;
|
||||
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
|
||||
DEVELOPMENT_TEAM = Q5486ZVAFT;
|
||||
ENABLE_HARDENED_RUNTIME = YES;
|
||||
@@ -325,7 +325,7 @@
|
||||
"$(inherited)",
|
||||
"@executable_path/../Frameworks",
|
||||
);
|
||||
MARKETING_VERSION = 26.0.15;
|
||||
MARKETING_VERSION = 26.0.26;
|
||||
PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon;
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
SWIFT_EMIT_LOC_STRINGS = YES;
|
||||
@@ -341,7 +341,7 @@
|
||||
CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements;
|
||||
CODE_SIGN_STYLE = Automatic;
|
||||
COMBINE_HIDPI_IMAGES = YES;
|
||||
CURRENT_PROJECT_VERSION = 35;
|
||||
CURRENT_PROJECT_VERSION = 56;
|
||||
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
|
||||
DEVELOPMENT_TEAM = Q5486ZVAFT;
|
||||
ENABLE_HARDENED_RUNTIME = YES;
|
||||
@@ -356,7 +356,7 @@
|
||||
"$(inherited)",
|
||||
"@executable_path/../Frameworks",
|
||||
);
|
||||
MARKETING_VERSION = 26.0.15;
|
||||
MARKETING_VERSION = 26.0.26;
|
||||
PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon;
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
SWIFT_EMIT_LOC_STRINGS = YES;
|
||||
|
||||
@@ -46,6 +46,13 @@ generate_appcast() {
|
||||
local staging_dir
|
||||
staging_dir="$(mktemp -d)"
|
||||
cp "$ARTIFACTS_DIR"/*.zip "$staging_dir"/ 2>/dev/null || true
|
||||
|
||||
if ! ls "$staging_dir"/*.zip >/dev/null 2>&1; then
|
||||
echo "ℹ️ Skipping Sparkle appcast generation (no ZIP archives found)."
|
||||
rm -rf "$staging_dir"
|
||||
return
|
||||
fi
|
||||
|
||||
echo "🧾 Generating Sparkle appcast at $output"
|
||||
if ! "$generator" \
|
||||
--download-url-prefix "$download_prefix" \
|
||||
@@ -70,6 +77,50 @@ sign_update_artifacts() {
|
||||
fi
|
||||
}
|
||||
|
||||
rewrite_appcast_urls() {
|
||||
: # no-op (old helper removed)
|
||||
}
|
||||
|
||||
submit_for_notarization() {
|
||||
local target="$1"
|
||||
local label="$2"
|
||||
echo "📝 Submitting ${label} for notarization..."
|
||||
xcrun notarytool submit "$target" \
|
||||
--apple-id "$NOTARY_APPLE_ID" \
|
||||
--team-id "$NOTARY_TEAM_ID" \
|
||||
--password "$NOTARY_PASSWORD" \
|
||||
--wait
|
||||
}
|
||||
|
||||
notarize_app_bundle() {
|
||||
local bundle="$1"
|
||||
local label="$2"
|
||||
if [[ -z "${NOTARY_APPLE_ID:-}" || -z "${NOTARY_TEAM_ID:-}" || -z "${NOTARY_PASSWORD:-}" ]]; then
|
||||
echo "ℹ️ Skipping notarization for ${label} (NOTARY_* variables not set)."
|
||||
return 1
|
||||
fi
|
||||
|
||||
local tmp_dir
|
||||
tmp_dir="$(mktemp -d)"
|
||||
local archive="$tmp_dir/$(basename "$bundle").zip"
|
||||
ditto -c -k --keepParent "$bundle" "$archive"
|
||||
|
||||
submit_for_notarization "$archive" "$label"
|
||||
xcrun stapler staple "$bundle"
|
||||
rm -rf "$tmp_dir"
|
||||
}
|
||||
|
||||
notarize_artifact() {
|
||||
local artifact="$1"
|
||||
local label="$2"
|
||||
if [[ -z "${NOTARY_APPLE_ID:-}" || -z "${NOTARY_TEAM_ID:-}" || -z "${NOTARY_PASSWORD:-}" ]]; then
|
||||
echo "ℹ️ Skipping notarization for ${label} (NOTARY_* variables not set)."
|
||||
return 1
|
||||
fi
|
||||
submit_for_notarization "$artifact" "$label"
|
||||
xcrun stapler staple "$artifact"
|
||||
}
|
||||
|
||||
if [[ -f "$CREDENTIALS_FILE" ]]; then
|
||||
set -a
|
||||
# shellcheck disable=SC1090
|
||||
@@ -113,6 +164,8 @@ else
|
||||
echo "⚠️ Skipping codesign (CODESIGN_IDENTITY not set)."
|
||||
fi
|
||||
|
||||
notarize_app_bundle "$APP_PATH" "iKeyMon.app"
|
||||
|
||||
STAGING_DIR=$(mktemp -d)
|
||||
mkdir -p "$STAGING_DIR"
|
||||
cp -R "$APP_PATH" "$STAGING_DIR/"
|
||||
@@ -138,15 +191,9 @@ hdiutil create -volname "iKeyMon" -srcfolder "$STAGING_DIR" -ov -format UDZO "$A
|
||||
sign_update_artifacts
|
||||
|
||||
if [[ -n "${NOTARY_APPLE_ID:-}" && -n "${NOTARY_TEAM_ID:-}" && -n "${NOTARY_PASSWORD:-}" ]]; then
|
||||
echo "📝 Submitting DMG for notarization..."
|
||||
xcrun notarytool submit "$ARTIFACTS_DIR/$DMG_NAME" \
|
||||
--apple-id "$NOTARY_APPLE_ID" \
|
||||
--team-id "$NOTARY_TEAM_ID" \
|
||||
--password "$NOTARY_PASSWORD" \
|
||||
--wait
|
||||
xcrun stapler staple "$ARTIFACTS_DIR/$DMG_NAME"
|
||||
notarize_artifact "$ARTIFACTS_DIR/$DMG_NAME" "$DMG_NAME"
|
||||
else
|
||||
echo "⚠️ Skipping notarization (NOTARY_* variables not set)."
|
||||
echo "⚠️ Skipping DMG notarization (NOTARY_* variables not set)."
|
||||
fi
|
||||
rm -rf "$STAGING_DIR"
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"marketing_version": "26.0.15"
|
||||
"marketing_version": "26.0.26"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user