https://github.com/macmade/githubupdates

Cocoa framework to install application updates from GitHub releases.
https://github.com/macmade/githubupdates

app cocoa download framework github install release sparkle update

Last synced: 6 days ago
JSON representation

Cocoa framework to install application updates from GitHub releases.

• Host: GitHub
• URL: https://github.com/macmade/githubupdates
• Owner: macmade
• License: mit
• Created: 2017-06-16T06:43:10.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-20T09:42:47.000Z (7 months ago)
• Last Synced: 2025-01-09T09:11:45.208Z (13 days ago)
• Topics: app, cocoa, download, framework, github, install, release, sparkle, update
• Language: Objective-C
• Size: 4.16 MB
• Stars: 435
• Watchers: 9
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
GitHubUpdates

=============

[![Build Status](https://img.shields.io/github/actions/workflow/status/macmade/GitHubUpdates/ci-mac.yaml?label=macOS&logo=apple)](https://github.com/macmade/GitHubUpdates/actions/workflows/ci-mac.yaml)

[![Issues](http://img.shields.io/github/issues/macmade/GitHubUpdates.svg?logo=github)](https://github.com/macmade/GitHubUpdates/issues)

![Status](https://img.shields.io/badge/status-active-brightgreen.svg?logo=git)

![License](https://img.shields.io/badge/license-mit-brightgreen.svg?logo=open-source-initiative)  

[![Contact](https://img.shields.io/badge/[email protected]?logo=twitter&style=social)](https://twitter.com/macmade)

[![Sponsor](https://img.shields.io/badge/sponsor-macmade-pink.svg?logo=github-sponsors&style=social)](https://github.com/sponsors/macmade)

About

-----

**GitHubUpdates is Cocoa framework to install application updates from GitHub releases.**  

If you ever used [Sparkle](https://github.com/sparkle-project/Sparkle), this project provided the same kind of functionalities, but works with your GitHub releases and tags.

![Update](Assets/Update.png "Update")

Documentation

-------------

Documentation and API reference can be found at: http://doc.xs-labs.com/GitHubUpdates/

How to use

----------

### Application Setup

The project provides a **Cocoa framework** that you can embed into your own application.  

A module is also defined, so you can either use:

    @import GitHubUpdates;

    

or:

    #import 

In order to check for updates, a `GitHubUpdater` object needs to be created:

    self.updater            = [ GitHubUpdater new ];

    self.updater.user       = @"MyGitHubUsername" 

    self.updater.repository = @"MyGitHubRepository";

Note that you can also create the `GitHubUpdater` instance with **InterfaceBuilder**.  

The `user` and `repository` properties are inspectable, so you can set them with the Interface Builder inspector palette.

![IB](Assets/IB.png "IB")

You can then check for updates using the IB action:

    [ self.updater checkForUpdates: nil ];

This method will show a progress window, while checking for available updates.  

You can also choose to check for updates in background:

    [ self.updater checkForUpdatesInBackground ];

With this method, the update window will only be shown if an update is available.

You can also check for updates periodically, using a timer:

    [ NSTimer scheduledTimerWithTimeInterval: 3600 target: self.updater selector: @selector( checkForUpdatesInBackground ) userInfo: nil repeats: YES ];

    

This will check for updates every hour.

### Create a release on GitHub

**GitHubUpdates** will check your GitHub tags to see if an update is available.

Your tags should correspond to the application's version number, as in `CFBundleShortVersionString`.  

There's no built-in support for `CFBundleVersion`, but that behaviour can be customized with `GitHubUpdaterDelegate` if needed.

Tags can be created on GitHub the following way:

    git tag 0.1.2 -m "0.1.2"

    git push origin --tags

Once you created a new tag, you'll need to upload a ZIP archive or a DMG file of your application to GitHub.  

Also note that your application should be at the first level of the ZIP archive or the DMG file.

Note that the installer will check the value of `CFBundleIdentifier`, so they need to match.

### Code-Signing

For obvious security reasons, the installer will also check code-signing properties.

While you can use **GitHubUpdates** without code-signing, the installer will refuse to install a non code-signed version, if the current version is code-signed.

Code-signing identities are also checked, and the installer will refuse to install an update if there's a mismatch in the code-signing identities.

License

-------

GitHubUpdates is released under the terms of the MIT license.

Repository Infos

----------------

    Owner:          Jean-David Gadina - XS-Labs

    Web:            www.xs-labs.com

    Blog:           www.noxeos.com

    Twitter:        @macmade

    GitHub:         github.com/macmade

    LinkedIn:       ch.linkedin.com/in/macmade/

    StackOverflow:  stackoverflow.com/users/182676/macmade