SparkleProject/sparkle-project.github.io
1
0
Fork 0
mirror of https://github.com/sparkle-project/sparkle-project.github.io.git synced 2025-11-01 15:35:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for 2.6.0 release (#216)

Browse Source
This commit is contained in:
Zorg
2024-03-15 11:51:42 -07:00
committed by GitHub
parent 9dd23ccba0
commit d7e5ea1a20
3 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/sandboxing/index.md
+5 -5
View File
@@ -56,7 +56,7 @@ The downloader service allows using Sparkle without forcing the network client e
* We fall back to using WebKit's deprecated `WebView` for release notes due to a [known WKWebView defect](https://github.com/feedback-assistant/reports/issues/1). Please file a bug report on [WebKit's issues tracker](https://webkit.org/reporting-bugs/) or a Feedback Assistant report to Apple relating to FB6993802 preventing the use of WKWebView without having the `com.apple.security.network.client` entitlement on your sandboxed application. Emphasize that this defect blocks your app's adoption from WebKit1 to WebKit2.
* [Adapting release notes based on the currently installed version](/documentation/publishing#adapting-release-notes-based-on-currently-installed-version) is not supported because this feature is not implemented for Sparkle's legacy WebKit view.
* It may not work well if your release notes reference external content that would require making additional network requests.
* As of Sparkle 2.6 (beta), the Downloader XPC Service is not sandboxed by default. If you want to sandbox this service, you will need to uncomment `DOWNLOADER_SANDBOXED_ENTITLEMENTS` and modify `XPC_SERVICE_BUNDLE_ID_PREFIX` in Sparkle's `ConfigCommon.xcconfig` when building Sparkle from source. Sandboxing this XPC Service requires using a custom bundle ID for it, otherwise conflicts may arise with other sandboxed apps using the service.
* As of Sparkle 2.6, the Downloader XPC Service is not sandboxed by default. If you want to sandbox this service, you will need to uncomment `DOWNLOADER_SANDBOXED_ENTITLEMENTS` and modify `XPC_SERVICE_BUNDLE_ID_PREFIX` in Sparkle's `ConfigCommon.xcconfig` when building Sparkle from source. Sandboxing this XPC Service requires using a custom bundle ID for it, otherwise conflicts may arise with other sandboxed apps using the service.
To enable the service, you must set [SUEnableDownloaderService](/documentation/customization#sandboxing-settings) boolean to `YES` in your application's Info.plist.
@@ -75,11 +75,11 @@ You may re-sign Sparkle for distribution manually if needed like so:
```sh
codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime Sparkle.framework/Versions/B/XPCServices/Installer.xpc
# For versions < 2.6
codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime --entitlements Entitlements/Downloader.entitlements Sparkle.framework/Versions/B/XPCServices/Downloader.xpc
# For Sparkle versions >= 2.6
codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime --preserve-metadata=entitlements Sparkle.framework/Versions/B/XPCServices/Downloader.xpc
# For versions >= 2.6 (beta)
#codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime --preserve-metadata=entitlements Sparkle.framework/Versions/B/XPCServices/Downloader.xpc
# For Sparkle versions < 2.6
#codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime --entitlements Entitlements/Downloader.entitlements Sparkle.framework/Versions/B/XPCServices/Downloader.xpc
codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime Sparkle.framework/Versions/B/Autoupdate
codesign -f -s "$CODE_SIGN_IDENTITY" -o runtime Sparkle.framework/Versions/B/Updater.app
documentation/security-and-reliability/index.md
+1
View File
@@ -9,6 +9,7 @@ These are a list of *major* security and reliability improvements in Sparkle, or
| Version | Changes |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| 2.6.0 | Fixes issue for sandboxed apps that enable the Downloader XPC Service from conflicting with each other and presenting a system dialog that "Downloader" differs from previously opened versions affecting macOS 14 and later ([#2511](https://github.com/sparkle-project/Sparkle/pull/2511)). Performs a Gatekeeper scan for signed app updates on macOS 14.4 and later so users don't see a system "Verifying..." dialog when an app update is relaunched ([#2505](https://github.com/sparkle-project/Sparkle/pull/2505)). |
| 2.5.2 | Fixes a rare corruption issue resulting in missing files in the installed bundle, which Gatekeeper may reject ([#2479](https://github.com/sparkle-project/Sparkle/pull/2479)). Adopts macOS 14 Sonoma's cooperative app activation APIs instead of using `-[NSApplication activateIgnoringOtherApps:]` which was deprecated in macOS 14 (mainly impacts background/dockless running apps) ([#2409](https://github.com/sparkle-project/Sparkle/pull/2409)). Fixes updates not installing when executed from a Sparkle CLI utility as root (sudo) user on macOS 14 Sonoma (impacts few out-of-app updaters) ([#2432](https://github.com/sparkle-project/Sparkle/pull/2432)). |
| 2.4.2 | Fixes `NSKeyedUnarchiver` decoding warning of appcast item that contains delta updates ([#2383](https://github.com/sparkle-project/Sparkle/pull/2383)). Hardens verification of passing the update's download to Sparkle's Autoupdate helper ([#2392](https://github.com/sparkle-project/Sparkle/pull/2392)). |
| 2.2.2 | Deprecates the `-s` flag to `generate_appcast` and `sign_update` for passing the private EdDSA key as a command line argument which is insecure ([#2170](https://github.com/sparkle-project/Sparkle/pull/2170)). Please use the Keychain, or pass the key as standard input in CI environments when using `--ed-key-file -` instead. Run these tools with `-h` for further information. |
documentation/upgrading/index.md
+1 -1
View File
@@ -6,7 +6,7 @@ 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.6 (beta)
## Upgrading to Sparkle 2.6
Sparkle 2.6 no longer sandboxes the Downloader XPC Service by default. If you enabled this XPC Service, please see the updated [sandboxing guide](/documentation/sandboxing) for more information.