Skip to content

ci: generate and publish signed Sparkle appcast in release workflow #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lonewolfyx merged 1 commit into from
Jul 13, 2026
Merged

ci: generate and publish signed Sparkle appcast in release workflow #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,27 @@ jobs:
echo "::warning::Gatekeeper rejected this app because the release is ad-hoc signed and not notarized."
fi

- name: Generate Sparkle appcast
shell: bash
env:
SPARKLE_PRIVATE_KEY: ${{ secrets.SPARKLE_PRIVATE_KEY }}
run: |
set -euo pipefail

if [ -z "$SPARKLE_PRIVATE_KEY" ]; then
echo "Missing required GitHub Actions secret: SPARKLE_PRIVATE_KEY" >&2
exit 1
fi

./scripts/update-appcast.sh \
--dmg "${{ steps.dmg.outputs.path }}" \
--output "$RUNNER_TEMP/appcast.xml" \
--tag "${{ steps.release.outputs.tag }}"

grep -F 'sparkle:edSignature=' "$RUNNER_TEMP/appcast.xml"
grep -F 'releases/download/${{ steps.release.outputs.tag }}/${{ steps.dmg.outputs.name }}' \
"$RUNNER_TEMP/appcast.xml"

- name: Create GitHub Release
run: npx --yes genereleaselog@latest --output false --assets "${{ steps.dmg.outputs.path }}"
env:
Expand All @@ -110,3 +131,23 @@ jobs:
| grep -Fx "${{ steps.dmg.outputs.name }}"
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish Sparkle appcast
shell: bash
run: |
set -euo pipefail

git fetch origin main
git checkout -B main origin/main
cp "$RUNNER_TEMP/appcast.xml" appcast.xml

if git diff --quiet -- appcast.xml; then
echo "appcast.xml is already current."
exit 0
fi

git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add appcast.xml
git commit -m "chore: update appcast for ${{ steps.release.outputs.tag }}"
git push origin HEAD:main
20 changes: 16 additions & 4 deletions scripts/update-appcast.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ APP_NAME="${APP_NAME:-AgentBar}"
DIST_DIR="${DIST_DIR:-$REPO_ROOT/dist}"
APPCAST_PATH="${APPCAST_PATH:-$REPO_ROOT/appcast.xml}"
SPARKLE_GENERATE_APPCAST="${SPARKLE_GENERATE_APPCAST:-generate_appcast}"
SPARKLE_PRIVATE_KEY="${SPARKLE_PRIVATE_KEY:-}"

VERSION="1.0.0"
BUILD_NUMBER="1"
Expand All @@ -35,7 +36,8 @@ Options:

Environment overrides:
APP_NAME, DIST_DIR, VERSION_ENV_FILE, DMG_PATH, APPCAST_PATH,
RELEASE_TAG, DOWNLOAD_URL_PREFIX, SPARKLE_GENERATE_APPCAST
RELEASE_TAG, DOWNLOAD_URL_PREFIX, SPARKLE_GENERATE_APPCAST,
SPARKLE_PRIVATE_KEY
EOF
}

Expand Down Expand Up @@ -113,9 +115,19 @@ trap cleanup EXIT HUP INT TERM

cp "$DMG_PATH" "$WORK_DIR/"

"$SPARKLE_GENERATE_APPCAST" \
--download-url-prefix "$DOWNLOAD_URL_PREFIX" \
"$WORK_DIR"
if [ -n "$SPARKLE_PRIVATE_KEY" ]; then
# Sparkle recommends passing the private key over standard input in CI so
# it is not exposed in the process arguments or written to disk.
printf '%s' "$SPARKLE_PRIVATE_KEY" \
| "$SPARKLE_GENERATE_APPCAST" \
--ed-key-file - \
--download-url-prefix "$DOWNLOAD_URL_PREFIX" \
"$WORK_DIR"
else
"$SPARKLE_GENERATE_APPCAST" \
--download-url-prefix "$DOWNLOAD_URL_PREFIX" \
"$WORK_DIR"
fi

if [ ! -f "$WORK_DIR/appcast.xml" ]; then
echo "generate_appcast did not create appcast.xml" >&2
Expand Down