Quick Start Guide
Get up and running with Sparkler in under 5 minutes. This guide will walk you through connecting your GitHub repository, setting up your first release, and publishing an update.
Prerequisites
- • A macOS application that uses the Sparkle framework
- • Your app code hosted on GitHub
- • A Sparkler account (get one here)
1Connect to GitHub
In your Sparkler dashboard, click on "Add New App" and select "Connect GitHub". You'll be prompted to authorize Sparkler to access your repositories.
Select the repository that contains your macOS app. Sparkler will automatically detect releases and tags from this repository.
2Configure Your App
Fill in the basic information about your app, including:
- App name
- Bundle identifier
- App icon (optional)
- Public EdDSA key (for verifying update signatures)
Note: Sparkler never stores your private key - only the public key used for signature verification.
3Setup GitHub Actions (Optional)
For automatic updates, add the Sparkler GitHub Action to your workflow. Copy this example configuration to your .github/workflows/release.yml file:
name: Release
on:
release:
types: [published]
jobs:
upload-to-sparkler:
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Build App
run: |
# Your build steps here
# ...
- name: Upload to Sparkler
uses: sparkler-app/upload-action@v1
with:
api-key: ${{ secrets.SPARKLER_API_KEY }}
app-id: your-app-id
artifact-path: path/to/your/app.zip4Publish Your First Update
After connecting GitHub and configuring your app:
- Create a new release on GitHub
- Attach your app binary to the GitHub release
- Wait for the GitHub Action to complete (if configured)
- In Sparkler dashboard, click "Publish" for the new version
That's it! Your update will now be available to all users of your app.
Update Your Sparkle Feed URL
Make sure your app is configured to use your Sparkler appcast URL:
https://sparkler.app/api/feed/your-app-idFor custom domains, check the Custom Domains guide.