From 52dd44fd4f5cbc715a2041508dbcd374bef0ce1a Mon Sep 17 00:00:00 2001 From: Zorg Date: Sun, 23 Feb 2025 06:57:55 -0800 Subject: [PATCH] Update 2.7 (beta) -> 2.7 --- documentation/customization/index.md | 2 +- documentation/delta-updates/index.md | 2 +- documentation/index.md | 2 +- documentation/publishing/index.md | 2 +- documentation/upgrading/index.md | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/customization/index.md b/documentation/customization/index.md index 4e94009..1856b5c 100644 --- a/documentation/customization/index.md +++ b/documentation/customization/index.md @@ -19,7 +19,7 @@ Here are the main routes by which you can bend Sparkle's behavior to your will: | `SUScheduledCheckInterval` | Number | The number of seconds between updates. The default is `86400` (1 day). Setting to 0 disables updates.

**Note:** this has a minimum bound of 1 hour in order to keep you from accidentally overloading your servers. | | `SUAllowsAutomaticUpdates` | Boolean | By default, Sparkle automatically presents your users with the *option* to allow to automatically download and install any available updates if automatic checking of updates is enabled.
Set this to `NO` to disallow automatic updates and require manual installation every time.
Set this to `YES` to always allow automatic updates even if automatic checking of updates is disabled. | | `SUAutomaticallyUpdate` | Boolean | Default: `NO`. Enables automatic download and installation of updates by default. If set to `YES`, Sparkle will attempt to download and install new updates silently in the background. In Sparkle 1, updates won't be opted into this if users need to provide authorization. In Sparkle 2, updates will be downloaded but not installed automatically if authorization is required. In all versions of Sparkle, if the application hasn't quit for 1 week the user will be presented with installing the downloaded update (unless the updater delegate overrides this).
This default property can later be overridden by setting [automaticallyDownloadsUpdates](/documentation/api-reference/Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)automaticallyDownloadsUpdates) in response to user setting changes. -| `SUVerifyUpdateBeforeExtraction` | Boolean | Default: `NO`. Set this to `YES` to force verification of updates before Sparkle extracts the downloaded update. Use this setting if you want stronger update validation and you aren't likely to lose access to your private EdDSA key (typically stored inside the macOS Keychain). EdDSA signing is required to use this setting. [Key rotation](/documentation/#rotating-signing-keys) is still possible by using Apple Developer ID code signed disk images as fallback. This setting is available in Sparkle 2.7 (beta) and later. | +| `SUVerifyUpdateBeforeExtraction` | Boolean | Default: `NO`. Set this to `YES` to force verification of updates before Sparkle extracts the downloaded update. Use this setting if you want stronger update validation and you aren't likely to lose access to your private EdDSA key (typically stored inside the macOS Keychain). EdDSA signing is required to use this setting. [Key rotation](/documentation/#rotating-signing-keys) is still possible by using Apple Developer ID code signed disk images as fallback. This setting is available in Sparkle 2.7 and later. | | `SUShowReleaseNotes` | Boolean | Default: `YES`. Set this to `NO` to hide release notes display from the update alert. | | `SUAllowedURLSchemes` | Array of Strings | An array of custom URL schemes allowed to be clicked from Sparkle's release notes view. By default, Sparkle only allows clicks to links that have a safe known URL scheme (like `https`). This setting is available in Sparkle 2.5 and later. | `SUBundleName` | String | Optional alternative bundle display name. For example, if your bundle name already has a version number appended to it, setting this may help smooth out certain messages, e.g. "MyApp 3 4.0 is now available" vs "MyApp 4.0 is now available". | diff --git a/documentation/delta-updates/index.md b/documentation/delta-updates/index.md index ce86695..f725890 100644 --- a/documentation/delta-updates/index.md +++ b/documentation/delta-updates/index.md @@ -69,7 +69,7 @@ When you create a delta update between two versions of your application, you mus | Delta Format | Supports | Changes | | --------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------- | -| 4 | Sparkle 2.7 (beta) | Preserves bundle creation date, more efficient hash verification. | +| 4 | Sparkle 2.7 | Preserves bundle creation date, more efficient hash verification. | | 3 | Sparkle 2.1 | More efficient custom delta container format, lzma compression + other compression options, file rename heuristic tracking. | | 2 | Sparkle 1.10 | Improved and changed hash function for reducing collisions. | | 1 | Sparkle 1.5 | Added initial binary delta format using libxar and bzip2 compression. Tracking of insertions, deletions, and binary file diffs using bsdiff. | diff --git a/documentation/index.md b/documentation/index.md index 6b6f448..a56efb8 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -153,7 +153,7 @@ If you distribute your app on your website as a ZIP or a tar archive (due to [ap If your app is running from a read-only mount, you can encourage (if you want) your user to move the app into /Applications. Some frameworks, although not officially sanctioned here, exist for this purpose. Note Sparkle will not by default automatically disturb your user if an update cannot be performed. -Sparkle supports updating from DMG, ZIP archives, tarballs, Apple Archives (as of Sparkle 2.7 beta / macOS 10.15), and [installer packages](/documentation/package-updates/), so you can generally reuse the same archive for distribution of your app on your website as well as Sparkle updates. +Sparkle supports updating from DMG, ZIP archives, tarballs, Apple Archives (as of Sparkle 2.7 / macOS 10.15), and [installer packages](/documentation/package-updates/), so you can generally reuse the same archive for distribution of your app on your website as well as Sparkle updates. ### 5. Publish your appcast diff --git a/documentation/publishing/index.md b/documentation/publishing/index.md index 5a82912..9f99812 100644 --- a/documentation/publishing/index.md +++ b/documentation/publishing/index.md @@ -29,7 +29,7 @@ tar --no-xattrs -cJf MyApp.tar.xz MyApp.app Note `--no-xattrs` assumes your application and its code signature does not rely on extended attributes and [places code and data into their proper places](https://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle). -For creating Apple Archives (`.aar`), check `man aa`. Sparkle 2.7 (beta) / macOS 10.15+ support this format. Enabling [SUVerifyUpdateBeforeExtraction](/documentation/customization/) is required for using this archive type. +For creating Apple Archives (`.aar`), check `man aa`. Sparkle 2.7 / macOS 10.15+ support this format. Enabling [SUVerifyUpdateBeforeExtraction](/documentation/customization/) is required for using this archive type. Please see [notes for Installer packages](/documentation/package-updates) if you are not updating a regular bundle. diff --git a/documentation/upgrading/index.md b/documentation/upgrading/index.md index b096828..6169965 100644 --- a/documentation/upgrading/index.md +++ b/documentation/upgrading/index.md @@ -6,9 +6,9 @@ title: Upgrading from previous versions of Sparkle We strongly recommend upgrading Sparkle to the [latest production release](//github.com/{{ site.github_username }}/Sparkle/releases) because there have been [important security and reliability improvements](/documentation/security-and-reliability). Very old versions of Sparkle also suffer some incompatibilities with the latest macOS versions. -## Upgrading to Sparkle 2.7 (beta) +## Upgrading to Sparkle 2.7 -Sparkle 2.7 (beta) introduces a new format for delta updates, which preserves the creation date of the app bundle and creates slightly more efficient patches. If you don't use `generate_appcast`, please check the [compatibility notes for creating delta updates](/documentation/delta-updates/#compatibility). +Sparkle 2.7 introduces a new format for delta updates, which preserves the creation date of the app bundle and creates slightly more efficient patches. If you don't use `generate_appcast`, please check the [compatibility notes for creating delta updates](/documentation/delta-updates/#compatibility). [Custom version comparators](/documentation/api-reference/Protocols/SPUUpdaterDelegate.html#/c:objc(pl)SPUUpdaterDelegate(im)versionComparatorForUpdater:) have been deprecated. Please use an increasing (numerical `x`, `x.y`, or `x.y.z`) `CFBundleVersion` / `sparkle:version` instead and disjoint them from more human presentable `CFBundleShortVersionString` / `sparkle:shortVersionString` if needed.