2.5.1 Release Notes + Sonoma Improvements

Changes:

• Default to English for XML nodes when no xml:lang is present (#2440) (Zorg)
• Filter for archive files in generate_appcast more intelligently (#2448) (Zorg)
• Use correct entitlements and dsym files when using custom bundle id and XPC names in ConfigCommon (#2446) (floorish)

Please also see the changes in 2.5.0.

2.5.0 Release Notes + Sonoma Improvements

Changes:

• Add ability to adapt release notes based on the currently installed version (#2373) (docs) (Nathan Manceaux-Panot)
• Allow developers to use custom URL schemes in the release notes view (#2393) (docs) (Zorg)
• Adopt cooperative app activation APIs in macOS 14 Sonoma (#2409) (Zorg)
• Improve permission prompt layout (#2420) (Zorg)
• Remove hyphenation in "You're up to date" message (#2425) (Zorg, Dom Neill)
• Pre-warm installs before relaunch and resolve sporadic failures in CI (#2421) (Zorg)
• Fix make release not building distribution successfully (#2430) (Zorg)
• Fix Updater app not starting when running Sparkle as root (e.g. from CLI with sudo or a daemon) on macOS 14 Sonoma (#2432) (Zorg)
• Fix KVO usage for updaterController.updater.* (#2404) (Zorg)
• Replace CFUUID* with NSUUID (#2395) (Eitot)
• Report an error when detecting duplicate updates in generate_appcast (#2407) (Zorg)
• Improve error for rejecting xattr based code signing for delta updates (#2408) (Zorg)
• Fail gracefully when auxiliary tool cannot be located (#2436) (Zorg)

This release includes enhancements to Sparkle's release notes view and compatibility improvements for macOS 14 Sonoma.

Discussion

2.5.0-beta.2

Changes since beta 1:

• Improve permission prompt layout (#2420) (Zorg)
• Remove hyphenation in "You're up to date" message (#2425) (Zorg, Dom Neill)
• Pre-warm installs before relaunch and resolve sporadic failures in CI (#2421) (Zorg)
• Fix make release not building distribution successfully (#2430) (Zorg)
• Fix Updater app not starting when running Sparkle as root (e.g. from CLI with sudo or a daemon) on macOS 14 Sonoma (#2432) (Zorg)

Overall Changes:

• Add ability to adapt release notes based on the currently installed version (#2373) (Nathan Manceaux-Panot)
• Allow developers to use custom URL schemes in the release notes view (#2393) (Zorg)
• Adopt cooperative app activation APIs in macOS 14 Sonoma (#2409) (Zorg)
• Improve permission prompt layout (#2420) (Zorg)
• Remove hyphenation in "You're up to date" message (#2425) (Zorg, Dom Neill)
• Pre-warm installs before relaunch and resolve sporadic failures in CI (#2421) (Zorg)
• Fix make release not building distribution successfully (#2430) (Zorg)
• Fix Updater app not starting when running Sparkle as root (e.g. from CLI with sudo or a daemon) on macOS 14 Sonoma (#2432) (Zorg)
• Fix KVO usage for updaterController.updater.* (#2404) (Zorg)
• Replace CFUUID* with NSUUID (#2395) (Eitot)
• Report an error when detecting duplicate updates in generate_appcast (#2407) (Zorg)
• Improve error for rejecting xattr based code signing for delta updates (#2408) (Zorg)

Discussion

2.5.0-beta.1

Changes:

• Add ability to adapt release notes based on the currently installed version (#2373) (Nathan Manceaux-Panot) (docs)
• Allow developers to use custom URL schemes in the release notes view (#2393) (Zorg) (docs)
• Adopt cooperative app activation APIs in macOS 14 Sonoma (#2409) (Zorg)
• Replace CFUUID* with NSUUID (#2395) (Eitot)
• Fix KVO usage for updaterController.updater.* (#2404) (Zorg)
• Report an error when detecting duplicate updates in generate_appcast (#2407) (Zorg)
• Improve error for rejecting xattr based code signing for delta updates (#2408) (Zorg)

This release includes enhancements Sparkle's release notes view and compatibility improvements for macOS 14 Sonoma.

Discussion

2.4.2 Size Reduction

Changes:

• Ignore release notes download when we shouldn't show release notes (#2381) (Zorg)
• Fix NSKeyedUnarchiver warning for not specifying keyed NSString class (#2381) (Zorg)
• Harden verification of Sparkle update download (#2392) (Zorg)

Please also see the changes in 2.4.0 and 2.4.1

2.4.1 Size Reduction

Changes:

• Remove auxiliary apps and relocate symbols in SPM package to resolve missing AvailableLibraries warnings (#2356) (Zorg)
• Add -Wno-declaration-after-statement to silence warnings that only apply to pre-C99 (#2345) (Kent Sutherland)
• Fix compile error when setting SPARKLE_EMBED_DOWNLOADER_XPC_SERVICE=0 (#2346) (Zorg)
• Improve how downloaded update is passed to the installer (#2359) (Zorg)

This update resolves a couple Xcode/compiler warnings when updating to Xcode 14.3.

Please also see the changes in 2.4.0

2.4.1-beta.1

Changes:

• Remove auxiliary apps and relocate symbols in SPM package to resolve missing AvailableLibraries warnings (#2356) (Zorg)
• Add -Wno-declaration-after-statement to silence warnings that only apply to pre-C99 (#2345) (Kent Sutherland)
• Fix compile error when setting SPARKLE_EMBED_DOWNLOADER_XPC_SERVICE=0 (#2346) (Zorg)

Please also see the changes in 2.4.0

2.4.0 Size Reduction

• Reduce code size
  • Enable deployment postprocessing in Release to properly strip debug symbols and strip all non-global symbols (#2286, #2305) (Zorg)
  • Remove duplicate Sparkle localization strings in Updater app (#2288) (Zorg)
  • Optimize codebase for generated code size (less properties, direct methods, etc) (#2305) (Zorg)
  • Add additional settings to ConfigCommon.xcconfig for disabling features
• Ask permission for automatically downloading and installing new updates (#2285) (Zorg)
• Add support for plain text release notes view that does not use web view (#2315) (Zorg)
• Update SUVersionDisplay to better customize and display how versions are shown (#2321) (Zorg)
• Add deprecations/warnings for incorrect background update checking usage (#2295) (Zorg)
• Deprecate -[SPUUpdater setFeedURL:] API and add -[SPUUpdater clearFeedURLFromUserDefaults] for migrating away from -[SPUUpdater setFeedURL:] (#2295)
• Trigger a new update check in -[SPUUpdater resetUpdateCycle] if the updater's feed or allowed channels have changed (#2324) (Zorg)
• Exit with an error if generate_appcast cannot sign an update that must be signed (#2322) (Zorg)
• Remove a redundant Apple code signing check when verifying new updates (#2341) (Zorg)
• Turn off auto-linking for XPC targets to alleviate circular dependency issues (#2332) (Daniel Jalkut)

This release lets users control the behavior of automatic downloading of updates when asked if Sparkle should check for updates automatically, allows developers to better control how versions are displayed, adds a new release notes view for plain-text release notes, and reduces the size of the framework by almost 50%. Make sure to keep your debug symbol (.dSYM) files around because symbols are now stripped more aggressively.

Discussion

2.4.0-beta.2

Changes since beta 1:

• Remove a redundant Apple code signing check when verifying new updates (#2341) (Zorg)
• Don't allow DSA-only updates to pass if DSA is disabled (#2340) (Zorg)

Overall changes:

• Reduce code size
  • Enable deployment postprocessing in Release to properly strip debug symbols and strip all non-global symbols (#2286, #2305) (Zorg)
  • Remove duplicate Sparkle localization strings in Updater app (#2288) (Zorg)
  • Optimize codebase for generated code size (less properties, direct methods, etc) (#2305) (Zorg)
  • Add additional settings to ConfigCommon.xcconfig for disabling features
• Ask permission for automatically downloading and installing new updates (#2285) (Zorg)
• Update SUVersionDisplay to better customize and display how versions are shown (#2321) (Zorg)
• Add deprecations/warnings for incorrect background update checking usage (#2295) (Zorg)
• Deprecate -[SPUUpdater setFeedURL:] API and add -[SPUUpdater clearFeedURLFromUserDefaults] for migrating away from -[SPUUpdater setFeedURL:] (#2295)
• Trigger a new update check in -[SPUUpdater resetUpdateCycle] if the updater's feed or allowed channels have changed (#2324) (Zorg)
• Exit with an error if generate_appcast cannot sign an update that must be signed (#2322) (Zorg)
• Remove a redundant Apple code signing check when verifying new updates (#2341) (Zorg)
• Turn off auto-linking for XPC targets to alleviate circular dependency issues (#2332) (Daniel Jalkut)

This release lets users control the behavior of automatic downloading of updates when asked if Sparkle should check for updates automatically, allows developers to better control how versions are displayed, and reduces the size of the framework by almost 50%. Make sure to keep your debug symbol (.dSYM) files around because symbols are now stripped more aggressively.

Discussion

2.4.0-beta.1

• Ask permission for automatically downloading and installing new updates (#2285) (Zorg)
• Update SUVersionDisplay to better customize and display how versions are shown (#2321) (Zorg)
• Reduce code size
  • Enable deployment postprocessing in Release to properly strip debug symbols and strip all non-global symbols (#2286, #2305) (Zorg)
  • Remove duplicate Sparkle localization strings in Updater app (#2288) (Zorg)
  • Optimize codebase for generated code size (less properties, direct methods, etc) (#2305) (Zorg)
  • Add additional settings to ConfigCommon.xcconfig for disabling features
• Add deprecations/warnings for incorrect update checking usage (#2295) (Zorg)
• Deprecate -[SPUUpdater setFeedURL:] API and add -[SPUUpdater clearFeedURLFromUserDefaults] for migrating away from -[SPUUpdater setFeedURL:] (#2295)
• Exit with an error if generate_appcast cannot sign an update that must be signed (#2322) (Zorg)
• Trigger a new update check in -[SPUUpdater resetUpdateCycle] if the updater's feed or allowed channels have changed (#2324) (Zorg)
• Turn off autolinking for XPC targets to alleviate circular dependency issues (#2332) (Daniel Jalkut)

This release lets users control the behavior of automatic downloading of updates when asked if Sparkle should check for updates automatically, allows developers to better control how versions are displayed, and reduces the size of the framework by almost 50%. Make sure to keep your debug symbol (.dSYM) files around because symbols are now stripped more aggressively.