Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
57dc68f434 | ||
|
|
e3b14e87fe | ||
|
|
1c7e14a9db | ||
|
|
fc3e55294a | ||
|
|
02828c8d5b | ||
|
|
3f849d0db6 |
16
README.md
16
README.md
@@ -65,12 +65,14 @@ GITEA_REPO="iKeyMon"
|
||||
|
||||
`GITEA_TARGET_COMMIT` defaults to the current `HEAD` commit, so overriding it lets you publish from another branch if needed. Whenever those variables are set, the script will create (or reuse) tag `v<version>` and upload both ZIP and DMG as release assets automatically.
|
||||
|
||||
If you re-run the release script for the same version, it removes any existing assets with the same filenames before uploading, so you never end up with duplicate ZIP/DMG files on the release page.
|
||||
|
||||
### Sparkle 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).
|
||||
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.
|
||||
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).
|
||||
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.
|
||||
@@ -79,6 +81,18 @@ Preferences expose Sparkle’s built-in toggles for “Automatically check” an
|
||||
|
||||
> 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.
|
||||
|
||||
### Automated release push
|
||||
|
||||
If you want `git push origin master` to build/sign/notarize/upload automatically, enable the provided pre-push hook:
|
||||
|
||||
```bash
|
||||
git config core.hooksPath hooks
|
||||
```
|
||||
|
||||
The hook (see `hooks/pre-push`) watches for pushes that include `refs/heads/master`, automatically bumps `marketing_version` (incrementing the last component), runs `scripts/build_release.sh`, stages `version.json`, `iKeyMon.xcodeproj/project.pbxproj`, and `Sparkle/appcast.xml`, then creates a commit `chore: release <version>`. It performs its own `git push` behind the scenes and cancels the original push command so you don't upload the same refs twice—once you see “Release … pushed. Original push cancelled”, you're done (Git will report the original push failed; that's expected). To skip the automation temporarily, prepend `SKIP_RELEASE=1` to your `git push` command.
|
||||
|
||||
The bumping logic lives in `scripts/bump_version.sh` (feel free to run it manually if you need to create a release without pushing).
|
||||
|
||||
### Versioning workflow
|
||||
|
||||
- The canonical marketing version lives in `version.json` and follows the format `YY.major.minor` (example: `26.1.2`). Update that file manually whenever you cut a new release branch.
|
||||
|
||||
28
Sparkle/appcast.xml
vendored
28
Sparkle/appcast.xml
vendored
@@ -3,12 +3,28 @@
|
||||
<channel>
|
||||
<title>iKeyMon</title>
|
||||
<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>
|
||||
<title>26.0.16</title>
|
||||
<pubDate>Tue, 25 Nov 2025 18:34:19 +0100</pubDate>
|
||||
<sparkle:version>39</sparkle:version>
|
||||
<sparkle:shortVersionString>26.0.16</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=="/>
|
||||
<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=="/>
|
||||
</item>
|
||||
<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=="/>
|
||||
</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=="/>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>
|
||||
</rss>
|
||||
62
hooks/pre-push
Executable file
62
hooks/pre-push
Executable file
@@ -0,0 +1,62 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
REMOTE_NAME="${1:-origin}"
|
||||
|
||||
if [[ -n "${SKIP_RELEASE:-}" ]]; then
|
||||
echo "⚙️ SKIP_RELEASE set — skipping automated release build."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
should_release=false
|
||||
release_local_ref=""
|
||||
release_remote_ref=""
|
||||
while read -r local_ref local_sha remote_ref remote_sha; do
|
||||
[[ -z "${local_ref:-}" ]] && continue
|
||||
if [[ "$local_ref" == "refs/heads/master" || "$remote_ref" == "refs/heads/master" ]]; then
|
||||
should_release=true
|
||||
release_local_ref="$local_ref"
|
||||
release_remote_ref="${remote_ref:-refs/heads/master}"
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ "$should_release" != true ]]; then
|
||||
current_branch="$(git -C "$ROOT_DIR" symbolic-ref --short -q HEAD || true)"
|
||||
if [[ "$current_branch" == "master" ]]; then
|
||||
should_release=true
|
||||
release_local_ref="refs/heads/master"
|
||||
release_remote_ref="refs/heads/master"
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ "$should_release" != true ]]; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "🚀 Detected push to master — bumping version and building release..."
|
||||
NEW_VERSION="$("$ROOT_DIR/scripts/bump_version.sh")"
|
||||
echo "🔢 marketing_version -> ${NEW_VERSION}"
|
||||
"$ROOT_DIR/scripts/sync_version.sh"
|
||||
|
||||
git -C "$ROOT_DIR" add "$ROOT_DIR/version.json" "$ROOT_DIR/iKeyMon.xcodeproj/project.pbxproj"
|
||||
|
||||
"$ROOT_DIR/scripts/build_release.sh"
|
||||
|
||||
git -C "$ROOT_DIR" add "$ROOT_DIR/version.json" "$ROOT_DIR/iKeyMon.xcodeproj/project.pbxproj" "$ROOT_DIR/Sparkle/appcast.xml"
|
||||
|
||||
if git -C "$ROOT_DIR" diff --cached --quiet; then
|
||||
echo "⚠️ No release changes detected; skipping release commit."
|
||||
else
|
||||
git -C "$ROOT_DIR" commit -m "chore: release ${NEW_VERSION}"
|
||||
echo "📝 Committed release ${NEW_VERSION}."
|
||||
fi
|
||||
|
||||
echo "📤 Pushing release commit..."
|
||||
if SKIP_RELEASE=1 git -C "$ROOT_DIR" push "$REMOTE_NAME" "${release_local_ref:-refs/heads/master}:${release_remote_ref:-refs/heads/master}"; then
|
||||
echo "✅ Release ${NEW_VERSION} pushed. Original push cancelled (already done)."
|
||||
exit 1
|
||||
else
|
||||
echo "❌ Failed to push release ${NEW_VERSION}. Please resolve manually."
|
||||
exit 1
|
||||
fi
|
||||
@@ -310,7 +310,7 @@
|
||||
CODE_SIGN_ENTITLEMENTS = iKeyMon.entitlements;
|
||||
CODE_SIGN_STYLE = Automatic;
|
||||
COMBINE_HIDPI_IMAGES = YES;
|
||||
CURRENT_PROJECT_VERSION = 32;
|
||||
CURRENT_PROJECT_VERSION = 39;
|
||||
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
|
||||
DEVELOPMENT_TEAM = Q5486ZVAFT;
|
||||
ENABLE_HARDENED_RUNTIME = YES;
|
||||
@@ -325,7 +325,7 @@
|
||||
"$(inherited)",
|
||||
"@executable_path/../Frameworks",
|
||||
);
|
||||
MARKETING_VERSION = 26.0.13;
|
||||
MARKETING_VERSION = 26.0.16;
|
||||
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 = 32;
|
||||
CURRENT_PROJECT_VERSION = 39;
|
||||
DEVELOPMENT_ASSET_PATHS = "\"Preview Content\"";
|
||||
DEVELOPMENT_TEAM = Q5486ZVAFT;
|
||||
ENABLE_HARDENED_RUNTIME = YES;
|
||||
@@ -356,7 +356,7 @@
|
||||
"$(inherited)",
|
||||
"@executable_path/../Frameworks",
|
||||
);
|
||||
MARKETING_VERSION = 26.0.13;
|
||||
MARKETING_VERSION = 26.0.16;
|
||||
PRODUCT_BUNDLE_IDENTIFIER = net.24unix.iKeyMon;
|
||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||
SWIFT_EMIT_LOC_STRINGS = YES;
|
||||
|
||||
24
scripts/bump_version.sh
Executable file
24
scripts/bump_version.sh
Executable file
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
VERSION_FILE="$ROOT_DIR/version.json"
|
||||
|
||||
new_version="$(python3 - "$VERSION_FILE" <<'PY'
|
||||
import json, sys, pathlib
|
||||
path = pathlib.Path(sys.argv[1])
|
||||
data = json.loads(path.read_text())
|
||||
current = data.get("marketing_version")
|
||||
if not current:
|
||||
raise SystemExit("marketing_version missing in version.json")
|
||||
parts = current.split(".")
|
||||
if len(parts) != 3 or not all(part.isdigit() for part in parts):
|
||||
raise SystemExit(f"Invalid marketing_version format: {current}")
|
||||
parts[-1] = str(int(parts[-1]) + 1)
|
||||
data["marketing_version"] = ".".join(parts)
|
||||
path.write_text(json.dumps(data, indent=2) + "\n")
|
||||
print(data["marketing_version"])
|
||||
PY
|
||||
)"
|
||||
|
||||
echo "$new_version"
|
||||
@@ -63,11 +63,28 @@ if [[ -z "$release_id" || "$release_id" == "null" ]]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
delete_existing_asset() {
|
||||
local filename="$1"
|
||||
local asset_id
|
||||
asset_id="$(curl -sS \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_URL}/releases/${release_id}/assets" | jq -r --arg name "$filename" '.[] | select(.name == $name) | .id' | head -n 1)"
|
||||
if [[ -n "$asset_id" && "$asset_id" != "null" ]]; then
|
||||
echo "🗑️ Removing existing asset ${filename}"
|
||||
curl -sS \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-X DELETE \
|
||||
"${API_URL}/releases/${release_id}/assets/${asset_id}" >/dev/null
|
||||
fi
|
||||
}
|
||||
|
||||
upload_asset() {
|
||||
local file="$1"
|
||||
local filename
|
||||
filename="$(basename "$file")"
|
||||
|
||||
delete_existing_asset "$filename"
|
||||
|
||||
echo "⬆️ Uploading ${filename}"
|
||||
curl -sS \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
@@ -78,8 +95,4 @@ upload_asset() {
|
||||
upload_asset "$ZIP_PATH"
|
||||
upload_asset "$DMG_PATH"
|
||||
|
||||
if [[ -n "${SPARKLE_APPCAST_OUTPUT:-}" && -f "${SPARKLE_APPCAST_OUTPUT}" ]]; then
|
||||
upload_asset "$SPARKLE_APPCAST_OUTPUT"
|
||||
fi
|
||||
|
||||
echo "🎉 Release ${RELEASE_TAG} assets uploaded."
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"marketing_version": "26.0.13"
|
||||
"marketing_version": "26.0.16"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user