This fixes a regression introduced in Sparkle 2.9 when signed feeds were added. In our documentation we have suggested surrounding the release notes URL with newline/whitespace for pretty-print formatting reasons. However now that this bug surfaced, the documentation will be updated to remove the extraneous whitespace. Many developers generating appcasts programmatically or with generate_appcast will not run into this issue.
This changes the UI for the update alert to have the app icon be more stacked / inlined with the UI, refines the box view for release notes, and removes some title labels that aren't strictly needed. For Tahoe, we opt into using large size buttons which get a capsule shape.
Also this changes adds a new app icon, which is squircle shaped, for the Sparkle test when running on Tahoe.
* Update changelog for Sparkle 2
* Add more updates about appcast elements/attributes
* Clarify bestValidUpdateInAppcast method is discouraged for some cases
* Re-order changelog bullets
* Use https:// in sample links
We should recommend using sparkle:version and sparkle:shortVersionString elements inside the appcast item instead of inside the enclosure for consistency.
Delta updates do not need to specify sparkle:version, and can inherit the top level element. This clears up some confusion and reduces duplication (and reduces error proneness / saves me work when testing delta / info-only features).
This is also consistent with informational updates. Regardless whether you want to make an update informational only or not, the sparkle:version stays in the same top-level place.
This is a backwards compatible change. Very old versions of Sparkle (possibly up to a decade or more ago) have supported specifying sparkle:version as a top level item. Winsparkle supports it as well because it's needed for info-only updates.
This is only changing what we recommend / standardize. The attribute variants are still usable.
External tools relying on Sparkle's feed format may have to adapt to this standardization (they have always needed to support info-only updates with a missing enclosure which apps do leverage anyway).
I updated generate_appcast to prefer the element variants and updated the tool so it understands them (this was a bug).
We fallback to legacy WebView in two cases:
* On systems prior to macOS 10.11 (it may be possible to support WKWebView in 10.10, but due to an 10.11+ only API I didn't bother putting in the effort)
* For apps using the downloader XPC service which are most likely sandboxed apps without an outgoing network entitlement. WKWebView doesn't function in that case (FB6993802 - https://github.com/feedback-assistant/reports/issues/1)
Additional notes:
* Added an abstraction for using WebView or WKWebView
* Web view is created and inserted programmatically rather than from the nib which has previously caused issues (and is not allowed for WKWebView prior to 10.12 due to some NSCoding bug).
* We need to rely on WKWebView private API for drawing transparent background (FB7539179 - https://github.com/feedback-assistant/reports/issues/81). Additional notes in the code.
* We always inject a custom stylesheet for dark mode colors and default font family/size (for WKWebView).
* This should also improve the Catalyst support story (#1482)
This is done by applying a user stylesheet, making the background of the WebView transparent, and using a NSBox to display the dynamic dark background color. The appearance of the release notes will unfortunately not adapt if the theme is changed while the release notes window is open.