Skip to content

/ Sparkle

A software update framework for macOS
update software-update macos framework
Objective-C Swift Python Shell Makefile Ruby C
  1. Objective-C 47.7%
  2. Swift 44.0%
  3. Python 4.3%
  4. Shell 2.4%
  5. Makefile 0.7%
  6. Ruby 0.6%
  7. C 0.3%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@kornelski
kornelski Merge pull request #1596 from rajivshah3/chore/swiftlint
Latest commit 8a9963b May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Add Issue templates for Sparkle 1.x and 2.x Dec 14, 2019
Configurations Remove old code coverage configurations May 26, 2020
Documentation 2 tiny fixes Nov 20, 2018
Resources Losslessly reduced the size of PNG Feb 5, 2019
Sparkle.xcodeproj Set Swift Language Version to 4.2 in top level config May 26, 2020
Sparkle Persian translation May 18, 2020
TestApplication Use recommended locale names Jun 29, 2019
Tests Merge pull request #1596 from rajivshah3/chore/swiftlint May 26, 2020
UITests Allow force tries and force casts in tests May 25, 2020
Vendor Move ed25519 dependency to the Vendor directory May 28, 2019
bin/old_dsa_scripts Make legacy script use a smaller DSA key that macOS still supports Nov 13, 2018
fileop Explicitly specify types to silence "Messaging unqualified id" warnin… Jun 14, 2018
generate_appcast Relax rules a bit May 25, 2020
generate_keys Run SwiftLint autocorrect May 25, 2020
objc_dep Detect and fail if any two-way dependencies exist in the project Feb 6, 2017
sign_update Run SwiftLint autocorrect May 25, 2020
.clang-format Comment problematic clang-format property. Jun 6, 2015
.gitignore Add Carthage/Build to .gitignore Jul 22, 2016
.gitmodules Move ed25519 dependency to the Vendor directory May 28, 2019
.swiftlint.yml Relax rules a bit May 25, 2020
.travis.yml Only use Xcode 10.3 and 11.4 May 26, 2020
CHANGELOG Bump May 13, 2020
CODE_OF_CONDUCT.md CoC Sep 2, 2016
LICENSE Add my name to LICENSE Feb 2, 2017
Makefile Compress with lzma Feb 11, 2020
Makefile-icon Rename Sparkle.icns to be consistent with ASSETCATALOG_COMPILER_APPIC… Nov 9, 2016
README.markdown Update README.markdown Mar 17, 2020
Sparkle.podspec Fix CI test script May 26, 2020

README.markdown

Sparkle 1.x Build Status Carthage compatible CocoaPods sponsored by: StackPath

Secure and reliable software update framework for Cocoa developers.

Sparkle shows familiar update window with release notes

This branch is the production ready, battle-tested version of Sparkle used by thousands of Mac apps.
The upcoming Sparkle 2 (currently in beta) can be found in the 2.x branch.

Features

  • Seamless. There's no mention of Sparkle; your icons and app name are used.
  • Secure. Updates are verified using EdDSA signatures and Apple Code Signing.
  • Fast. Supports delta updates which only patch files that have changed.
  • Easy to install. Sparkle requires no code in your app, and only needs static files on a web server.
  • Supports bundles, preference panes, plugins, and other non-.app software. Can install .pkg files for more complicated products.
  • Handles permissions, quarantine and automatically asks for authentication if needed.
  • Uses RSS-based appcasts for release information. Appcasts are a de-facto standard supported by 3rd party update-tracking programs and websites.
  • Stays hidden until second launch for better first impressions.
  • Truly self-updating — the user can choose to automatically download and install all updates in the background.
  • Ability to mark updates as critical.
  • Progress and status notifications for the host app.

Requirements

  • Runtime: macOS 10.7 or greater
  • Build: Xcode 9 and 10.11 SDK or greater
  • HTTPS server for serving updates (see App Transport Security)
  • No sandboxing. Sparkle 1.x can't update sandboxed apps. However, Sparkle 2.x can.

Usage

See getting started guide. No code is necessary, but a bit of Xcode configuration is required.

Development

This repository uses git submodules, and will not build unless you clone recursively. Also, GitHub-provided ZIP/tar archives are broken due to GitHub not supporting git submodules properly.

git clone --recursive https://github.com/sparkle-project/Sparkle

Troubleshooting

  • Please check Console.app. Sparkle prints detailed information there about all problems it encounters. It often also suggests solutions to the problems, so please read Sparkle's log messages carefully.

  • Use the generate_appcast tool which creates appcast files, correct signatures, and delta updates automatically.

  • Make sure the URL specified in SUFeedURL is valid (typos/404s are a common error!), and that it uses modern TLS (test it).

  • Delete your app's preferences (in ~/Library/Preferences/<your bundle id>) if you've set another feed URL programmatically via Sparkle's Objective-C interface.

API symbols

Sparkle is built with -fvisibility=hidden -fvisibility-inlines-hidden which means no symbols are exported by default. If you are adding a symbol to the public API you must decorate the declaration with the SU_EXPORT macro (grep the source code for examples).

Building the distribution package

cd to the root of the Sparkle source tree and run make release. Sparkle-VERSION.tar.bz2 will be created in a temporary directory and revealed in Finder after the build has completed.

Alternatively, build the Distribution scheme in the Xcode UI.

Code of Conduct

We pledge to have an open and welcoming environment. See our Code of Conduct.

Project Sponsor

StackPath

You can’t perform that action at this time.