Upgrade to Sparkle 2 #1332
Merged
Upgrade to Sparkle 2 #1332
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This relies on #1331 so needs that to be merged first before this gets rebased. |
ychin
added
Updater
|
Ping @ichizok if you are interested to take a look. |
ichizok
reviewed
Nov 1, 2022
.github/workflows/ci-macvim.yaml
Outdated
|
|
||
| # Use Sparkle 1 because Sparkle 2 requires newer OS version than our legacy build. | ||
| # Later, we pass the --enable-sparkle_1 flag to configure to set the corresponding ifdef. | ||
| rm src/MacVim/Sparkle.framework && ln -s Sparkle_1.framework src/MacVim/Sparkle.framework |
There was a problem hiding this comment.
It can remove rm ... and change ln -s ... to ln -fhs ....
|
Looks from CI that older versions of Xcode do not like a symlinked Sparkle.framework. Will need to do some investigation. This could be mildly annoying because someone on say macOS 10.13 may have problem building this unless they do some extra steps. Maybe instead of using a symlink I will just make Edit: Turned out the issue is that Sparkle_2.framework is built with newer tooling so Xcode 11 cannot handle it properly, so just made it so that Xcode 11 build will use Sparkle_1.framework similar to the legacy build. |
ychin
force-pushed
the
sparkle-2
branch
5 times, most recently
from
af65aff
to
bbcc549
Compare
This is to prepare for adding Sparkle 2 support and using a symlink lets us switch between the two depending on what macOS version we are targeting.
This adds Sparkle 2 to the project add changes the symlink to point to it. This version has changed the min OS requirement from 10.9 to 10.13, and as such we keep the old Sparkle 1 around, and during CI, we swap to it when building legacy binary (regular MacVim has minOS set to 10.13, while legacy has min OS set to 10.9).
Add a configure flag to set the USE_SPARKLE_1 ifdef flag. In CI legacy builds, we will relink the symlink to point to Sparkle_1.framework and also call that configure flag so the code will build.
Use the updated API (SPUStandardUpdaterController instead of SUUpdater). Old functionality now use a USE_SPARKLE_1 compiler define to switch to old behavior when building for legacy builds. Add a delegate class that we can use to customize Sparkle behavior. Also, make sure DISABLE_SPARKLE will prevent including headers as well - Previously it was a mistake to keep including the headers. Now it should be completely de-coupled.
Add a new option for the user to opt-in for getting pre-release software. When turned on, Sparkle will accept a new "prerelease" channel for updates. This feature only works in Sparkle 2, which means legacy binaries (10.9-10.12) which use Sparkle 1 won't get this. It's possible to implement this for Sparkle 1 but we would need to do so in a completely different (and more annoying) manner of using two separate appcast XML files and switch among them. Given the niche nature of legacy binaries, this is not worth doing. The setting is in the Advanced settings pane because the pre-release builds aren't guaranteed to be stable or well-tested, so we don't want users to turn it on unless they looked for it. For terminology, went back and forth on "beta", "preview", "pre-release", and eventually settled on "pre-release" builds which also lines up with GitHub Release's convention.
ychin
added a commit
that referenced
this pull request
Feb 7, 2023
Updated to Vim 9.0.1276 Features ==================== Dictionary lookup -------------------- You can now use Force Touch or Cmd-Ctrl-D to look up definitions of word under the cursor (or selected text in visual mode). This will also preview URLs, and support data types such as phone numbers and addresses. #1312 #1313 This feature can also be invoked programmatically from VimScript (see `:h macvim-lookup`). #1315 Tool bar / Touch Bar / menu icons -------------------- You can now use SF Symbols for Tool bar and Touch Bar icons, including using different symbol styles such as "palette" or "multicolor". Menu items can now also use the `icon=` syntax to specify icons as well. See `:help macvim-toolbar-icon` for details. #1329 The default tool bar also has updated icons to look similar to SF Symbols used by newer macOS versions. #1214 by @sfsam Window management actions -------------------- There are new `macaction`'s for managing the MacVim window. The new `zoomLeft`/`zoomRight` actions allow you to pin the window to the left/right of the screen, and there are also new actions for interacting with Stage Manager (requires macOS 13+). See `:h macvim-actions` for details. #1330 Pre-release updates / Sparkle 2 -------------------- MacVim now supports pre-release software builds. It's sometimes hard for us to release frequent updates due to the desire to pick a stable upstream Vim version, needing to test the release on multiple OS versions, making sure there aren't half-complete or buggy features, and other reasons. This new feature now allows us to push pre-release beta builds out in a more frequent fashion, which could be useful if there are particular features or fixes that you would like to try out before the next official release. Pre-release builds will be released depending on bug fixes and features instead of a fixed cadence. Do note that these pre-release builds may not be as well-validated and may have half-baked features. If you are using the built-in auto-updater to update MacVim, you can turn this on by going to Advanced settings pane, and enable "Enable pre-release software updates". This feature is only available for macOS 10.13 or above. The auto-updater has also been updated from Sparkle 1.27.1 to 2.3.0 for 10.13+ builds. Legacy (10.9-10.12) builds are still using Sparkle 1. See #1332. New Vim features -------------------- New `smoothscroll` option allows you to scroll through a long wrapped line (using Ctrl-E or mouse wheel) without immediately jumping to the next line. (v9.0.0640) `splitscroll` option has been renamed `splitkeep`, with more flexibility than before. (v9.0.0647) Sound playback on macOS is now supported. You can use `has('sound')` to check. See `help sound` for details. (v9.0.0694) Terminals now support `:confirm` for `:q`, etc, which also means MacVim's Cmd-W will work properly for terminal windows. (v9.0.0710) Virtual text had numerous bugs fixed. General ==================== Legacy build for 10.9 - 10.12 -------------------- Per a previous announcement (#1271), the default MacVim binary will now require macOS 10.13 or above. Users of macOS 10.9 - 10.12 can use a separate "legacy" build which will still be supported. The legacy binary will still have the latest versions of Vim and be supported, but may not have all the latest features (e.g. pre-release builds). If you are using the auto-updater (Sparkle) to update MacVim, it should "just work" and find the best version for you. If you are downloading MacVim from the website, there is also a link to download the legacy version marked for 10.9+ as well. If you download the normal binary marked for 10.13+ from the website, it won't work on these older macOS versions. See #1331. Fixes ==================== CoreText Renderer clipping and rendering bugs -------------------- Unicode characters with multiple composing characters (e.g. "x⃗") will now render correctly. #1172 Texts (e.g. Tibetan, Zalgo texts) that are taller than the line height will no longer be clipped inappropriately. You can use a new setting `MMRendererClipToRow` to re-enable clipping if the tall texts are distracting. #995 / #1356 Tab crash -------------------- Fixed a crash when opening new tabs that seems to only occur in macOS 13 Ventura. #1333 Other bugs -------------------- - Fixed non-native full screen not working well with the notch on newer MacBook's when set to not show menu bar. You can also use `MMNonNativeFullScreenSafeAreaBehavior` to force MacVim to use the notch area as well if you don't mind some content being obscured. Note that the previous release also claimed it fixed this, but because the binary was built against an old macOS SDK (Big Sur), the fix did not work in the binary release. #1261 - Allow "Open untitled window: never" and "After last window closes: Quit MacVim" to be set together again. Added safeguards to make sure doing so won't immediately close the app. #1338 - Edit.Cut / Copy menu items will now be properly disabled when there isn't selected text. #1308 - Fixed potential `:emenu` crash when the menu is associated with an action in a non-valid mode. #1305 - Fixed bug where just bringing up the right-click (or the MacVim→Services) menu would somehow copy the selected texts to the system clipboard. #1300 - Fixed a Japanese input method bug where using left/right arrow to move to a different section of the input text would previously result in the candidate list not showing up at the correct position. #1312 - Fix non-CoreText renderer not handling text styles like strikethrough correctly (note: this renderer has been deprecated for a while and you should not use it). #1296 - This release uses an older sh/bash syntax file because the latest one in Vim has a bug. #1358 Misc ==================== New settings: - "No drop shadows" (Appearance). #1301 - "Treat Ctrl-click as right-click" (Input) (#1326). This was previously configurable via command-line, but now also possible in the settings pane under the new "Input" category. "About MacVim" now reports the version number in a clearer way with clearly specified release number vs Vim version. Known Issues ==================== Printing -------------------- Printing using File→Print or `:hardcopy` is currently not working under macOS 13 Ventura due to its removal of PostScript support in the Preview app. This will be fixed in a later release. See the issue for workarounds. #1347 Scripting ==================== - Scripting languages versions: - Perl is now built against 5.30, up from 5.18. - Ruby is now built against 3.2, up from 3.1. Compatibility ==================== Requires macOS 10.9 or above. (10.9 - 10.12 requires downloading a separate legacy build) Script interfaces have compatibility with these versions: - Lua 5.4 - Perl 5.30 - Python2 2.7 - Python3 3.10 - Ruby 3.2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Upgrade from Sparkle 1 to Sparkle 2. Because Sparkle 2 now requires minimum macOS version to be 10.13, we can only use this for normal MacVim builds, but legacy binary (for 10.9-10.12) will need to use Sparkle 1 still. We now have separate Sparkle_1 / Sparkle_2.framework folders and symlink
Sparkle.frameworktoSparkle_2.framework. When doing legacy builds in CI, we change the symlink to point toSparkle_1.framework, and set the corresponding compiler ifdef so the code will know what to do.Also, add support for a new "prerelease" update channel (only available in Sparkle 2) which allows us to deploy pre-release / beta software to users who opt in (in the Advanced settings pane). This helps gather feedbacks during development before we push out full releases.