AutoUpdate

Modern async/await macOS app updater inspired by mxcl/AppUpdater

Features

• Swift 6 concurrency-first API
• GitHub Releases provider out of the box
• Semantic version comparison with prerelease support
• Asset matching compatible with the classic naming format
  • repo-1.2.3.zip
  • repo-1.2.3.tar.gz
  • repo-v1.2.3.zip
• Optional daily background checks via NSBackgroundActivityScheduler
• Code-sign identity verification before install
• Install-and-relaunch flow for in-place updates

Install

.package(url: "https://github.com/your-org/AutoUpdate.git", from: "1.0.0")

Quick start

import AutoUpdate

let updater = AppUpdater(
    owner: "your-github-owner",
    repository: "your-repo",
    allowPrereleases: false
)

Task {
    switch try await updater.prepareUpdateIfAvailable() {
    case .upToDate:
        break
        
    case .prepared(let preparedUpdate):
        try await updater.installAndRelaunch(preparedUpdate)
    }
}

GitHub proxy

If you use a GitHub proxy or mirror that expects the original GitHub URL to be appended after a base URL, pass gitHubProxyURL

let updater = AppUpdater(
    owner: "your-github-owner",
    repository: "your-repo",
    gitHubProxyURL: URL(string: "https://ghproxy.example.com"),
    allowPrereleases: false
)

This prefixes both the GitHub Releases API request and matching asset downloads, for example https://ghproxy.example.com/https://api.github.com/...

Scheduled checks

Task {
    await updater.startAutomaticChecks(
        every: 24 * 60 * 60,
        installAfterPreparation: false
    )
}