Add Sparkle auto update framework to the Mac build

.github/workflows/builds-macos.yml

@@ -37,6 +37,12 @@ jobs:
       with:
         python-version: '3.12'
 
+    - name: Install Python dependencies for tooling
+      if: startsWith(github.ref, 'refs/tags/')
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
     - name: Import Developer Certificate
       run: |
         echo "$MACOS_CERTIFICATE_BASE64" | base64 --decode > certificate.p12
@@ -51,7 +57,7 @@ jobs:
         MACOS_CERTIFICATE_PASSWORD: ${{ secrets.MACOS_CERTIFICATE_PASSWORD }}
         MACOS_CERTIFICATE_BASE64: ${{ secrets.MACOS_CERTIFICATE_BASE64 }}
         MACOS_TEMPORARY_KEYCHAIN_PASSWORD: $ {{ secrets.MACOS_TEMPORARY_KEYCHAIN_PASSWORD }}
-        
+
     - name: Build the MacOS DMG
       shell: bash
       run: |
@@ -69,6 +75,35 @@ jobs:
         TEAM_ID: ${{ secrets.TEAM_ID }}
         MACOS_TEMPORARY_KEYCHAIN_PASSWORD: $ {{ secrets.MACOS_TEMPORARY_KEYCHAIN_PASSWORD }}
 
+    - name: Download Sparkle signing tools
+      if: startsWith(github.ref, 'refs/tags/')
+      run: |
+        curl -L https://github.com/sparkle-project/Sparkle/releases/download/2.6.4/Sparkle-2.6.4.tar.xz -o Sparkle.tar.xz
+        tar -xJf Sparkle.tar.xz Sparkle-2.6.4/bin/sign_update
+        chmod +x Sparkle-2.6.4/bin/sign_update
+
+    - name: Extract Sparkle private key
+      if: startsWith(github.ref, 'refs/tags/')
+      env:
+        MAC_SPARKLE_PRIVATE_KEY: ${{ secrets.MAC_SPARKLE_PRIVATE_KEY }}
+      run: |
+        echo "$MAC_SPARKLE_PRIVATE_KEY" | base64 --decode > sparkle_private_key_ed25519.pem
+        chmod 600 sparkle_private_key_ed25519.pem
+
+    - name: Sign macOS update
+      if: startsWith(github.ref, 'refs/tags/')
+      run: |
+        Sparkle-2.6.4/bin/sign_update sparkle_private_key_ed25519.pem build/KnobKraft_Orm-${{env.ORM_VERSION}}-Darwin.dmg | tail -1 | awk '{print $NF}' > mac_update.sig
+
+    - name: Update macOS appcast feed
+      if: startsWith(github.ref, 'refs/tags/')
+      env:
+        APPCAST_ACCESS_TOKEN: ${{ secrets.APPCAST_ACCESS_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        python write_appcast.py --platform mac --signature-file mac_update.sig
+        python make_github_release.py
+
     - name: Archive DMG artifact
       uses: actions/upload-artifact@v4
       if: always()
@@ -86,3 +121,9 @@ jobs:
         tags: true
         draft: false
 
+    - name: Delete Sparkle signing materials
+      if: startsWith(github.ref, 'refs/tags/')
+      run: |
+        rm -f sparkle_private_key_ed25519.pem mac_update.sig Sparkle.tar.xz
+        rm -rf Sparkle-2.6.4
+

.github/workflows/builds-windows.yml

@@ -72,7 +72,7 @@ jobs:
         working-directory: Builds/The-Orm/RelWithDebInfo
         run: |
           sentry-cli upload-dif . --log-level=debug
-        
+
         # Thanks to https://svrooij.io/2021/08/17/github-actions-secret-file/
       - name: Extract update private key from secret
         if: startsWith(github.ref, 'refs/tags/')

CMakeLists.txt

@@ -1,10 +1,10 @@
 #
-#  Copyright (c) 2020 Christof Ruch. All rights reserved.
+#  Copyright (c) 2020-2025 Christof Ruch. All rights reserved.
 #
 #  Dual licensed: Distributed under Affero GPL license by default, an MIT license is available for purchase
 #
 
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.20)
 
 # Target a specific MacOS version.
 # JUCE 8 refuses to build for anything older than 10.11, so let's try that.
@@ -28,10 +28,16 @@ IF(APPLE)
 
   # For old Apple < macOS 10.15 and Linux, do not allow C++ 17 because it won't work. With the newer nlohmann::json, we can specify the C++ version to use
   add_compile_definitions(JSON_HAS_CPP_14)
+
+  # Required for Sparkle
+  set(BUILD_WITH_INSTALL_RPATH YES)	
 ENDIF()
 
+
 project(KnobKraft_Orm)
 
+OPTION(SPARKLE_UPDATES "Turn on Sparkle/WinSparkle update service")
+
 #set(USE_ASIO true)
 option(ASAN "Use Address Sanitization for Debug version (Windows only for now)" OFF)
 
@@ -72,11 +78,12 @@ else()
 	set(PYTHON_VERSION_TO_EMBED "3.12" CACHE STRING "Specify which version of Python should be used for embedding.")
 endif()
 
+# Include useful scripts for CMake
+cmake_policy(SET CMP0135 NEW)
+include(FetchContent REQUIRED)
+
 # On Windows, we need to download external dependencies
 IF (WIN32)
-    # Include useful scripts for CMake, and opt in for the new fetch content timestamp behavior
-    cmake_policy(SET CMP0135 NEW)
-    include(FetchContent REQUIRED)
 
     FetchContent_Declare(
 	  icu URL https://github.com/unicode-org/icu/releases/download/release-74-2/icu4c-74_2-Win64-MSVC2019.zip
@@ -138,8 +145,15 @@ ELSEIF(APPLE)
 	if (NOT CMAKE_BUILD_TYPE MATCHES Release)
 		add_compile_definitions(DEBUG)
 	endif()
-
-
+
+	IF(SPARKLE_UPDATES)
+		FetchContent_Declare(
+			sparkleframework
+			URL https://github.com/sparkle-project/Sparkle/releases/download/2.6.4/Sparkle-2.6.4.tar.xz
+		)
+		FetchContent_MakeAvailable(sparkleframework)
+    ENDIF()
+
     # The JUCE font rendering is really fat on macOS, let us try to disable this flag
     add_definitions(-DJUCE_DISABLE_COREGRAPHICS_FONT_SMOOTHING)
 ELSEIF(UNIX)

Makefile

@@ -35,7 +35,7 @@ apple: notarize staple verify-notarization
 
 configure:
 	@echo "Configuring build for type $(BUILD_TYPE) in directory $(BUILD_DIR), using Python from $(PYTHON_TO_USE)"
-	cmake -S . -B $(BUILD_DIR) -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DPYTHON_EXECUTABLE=$(PYTHON_TO_USE) -DCODESIGN_CERTIFICATE_NAME="$(APPLE_DEVELOPER_IDENTITY)"
+	cmake -S . -B $(BUILD_DIR) -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DPYTHON_EXECUTABLE=$(PYTHON_TO_USE) -DCODESIGN_CERTIFICATE_NAME="$(APPLE_DEVELOPER_IDENTITY)" -DSPARKLE_UPDATES=ON
 
 .PHONY: build
 build $(KNOBKRAFT_DMG):

The-Orm/AutoUpdaterInterface.h

@@ -0,0 +1,14 @@
+/*
+   Copyright (c) 2022 Christof Ruch. All rights reserved.
+
+   Dual licensed: Distributed under Affero GPL license by default, an MIT license is available for purchase
+*/
+
+#pragma once
+
+class AutoUpdaterInterface
+{
+public:
+  virtual ~AutoUpdaterInterface() = default;
+  virtual void checkForUpdates() = 0;
+};

The-Orm/CMakeLists.txt

@@ -4,7 +4,7 @@
 #  Dual licensed: Distributed under Affero GPL license by default, an MIT license is available for purchase
 #
 
-cmake_minimum_required(VERSION 3.14)
+cmake_minimum_required(VERSION 3.20)
 
 # Get the version from our sub cmakefile
 execute_process(
@@ -26,6 +26,7 @@ if(PROJECT_DEV_TAG STREQUAL "-dev")
     add_definitions(-DPROJECT_DEV)
 endif()
 
+
 # Export this variable to be use by the Azure
 # Append the version number to the github action environment file to be used by subsequent steps 
 if(DEFINED ENV{GITHUB_ENV})
@@ -36,7 +37,6 @@ OPTION(CRASH_REPORTING "Turn on crash reporting via Internet/Sentry")
 OPTION(SENTRY_LOGGING "Turn on logging of sentry events into the log window")
 set(SENTRY_DSN "Sentry DSN URL" CACHE STRING "https://YYYYYYYYYYYYYYYYYY@ZZZZZ.ingest.sentry.io/XXXX")
 set(D_LOG_SENTRY "")
-OPTION(SPARKLE_UPDATES "Turn on WinSparkle update service")
 
 configure_file("version.cpp.in" "version.cpp")
 
@@ -49,9 +49,17 @@ IF(CRASH_REPORTING)
 ENDIF()
 
 IF(SPARKLE_UPDATES)
-	message("Sparkle and WinSparkle updates are turned on, the executable will be linked against WinSparkle")
-	juce_add_binary_data(CodeSigning SOURCES "${CMAKE_CURRENT_LIST_DIR}/../codesigning/dsa_pub.pem") 
+if(WIN32)
+	juce_add_binary_data(CodeSigning SOURCES "${CMAKE_CURRENT_LIST_DIR}/../codesigning/dsa_pub.pem")
 	SET(WINSPARKLE_DISTRIBUTION_FILES "${WINSPARKLE_LIBDIR}/WinSparkle.dll")
+elseif(APPLE)
+	set(SPARKLE_FRAMEWORK_PATH ${sparkleframework_SOURCE_DIR})
+	message("Using Sparkle Framework from ${SPARKLE_FRAMEWORK_PATH}")
+	set(SPARKLE_LINK "-F${SPARKLE_FRAMEWORK_PATH}" "-framework Sparkle")
+else()
+	message(FATAL_ERROR "SPARKLE_UPDATES is only supported on Windows and macOS")
+endif()
+	message("Sparkle and WinSparkle updates are turned on")
 ENDIF()
 
 set(SOURCES
@@ -102,11 +110,18 @@ set(SOURCES
 	redist/agpl-3.0.txt
 )
 
-# Mac Icon Magic
 if(APPLE)
-set(KnobKraftOrm_ICON ${CMAKE_CURRENT_SOURCE_DIR}/resources/icon_orm.icns)
-set_source_files_properties(${KnobKraftOrm_ICON} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
-
+	IF(SPARKLE_UPDATES)
+		# Sparkle framework
+		message("Adding Mac Objective-C files for Sparkle")
+		set(SPARKLE_SOURCES MacSparkle.mm MacSparkle.h)
+	else()
+		set(SPARKLE_SOURCES "")
+	endif()
+	# Limit skip-build-rpath to macOS to match top-level install RPATH handling
+	set(CMAKE_SKIP_BUILD_RPATH TRUE)
+	set(KnobKraftOrm_ICON ${CMAKE_CURRENT_SOURCE_DIR}/resources/icon_orm.icns)
+	set_source_files_properties(${KnobKraftOrm_ICON} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
 ENDIF()
 
 set(MIDIKRAFT_LIBRARIES
@@ -126,8 +141,7 @@ set(MIDIKRAFT_LIBRARIES
 		knobkraft-generic-adaptation
 		pytschirp_embedded
 )
-
-add_executable(KnobKraftOrm MACOSX_BUNDLE WIN32 ${KnobKraftOrm_ICON} ${SOURCES})
+add_executable(KnobKraftOrm MACOSX_BUNDLE WIN32 ${KnobKraftOrm_ICON} ${SOURCES} ${SPARKLE_SOURCES})
 target_include_directories(KnobKraftOrm INTERFACE ${CMAKE_CURRENT_LIST_DIR})
 if (CRASH_REPORTING)
   target_include_directories(KnobKraftOrm SYSTEM PRIVATE "${SENTRY_INSTALL_PATH}/include")
@@ -171,6 +185,9 @@ IF(WIN32)
 		${SPARKLE_DEPENDENCY}
 		)
 ELSEIF(APPLE)
+	if(SPARKLE_UPDATES)
+		target_compile_options(KnobKraftOrm PRIVATE -F${SPARKLE_FRAMEWORK_PATH} -DUSE_SPARKLE)
+	endif()
 	target_link_libraries(KnobKraftOrm PRIVATE
 		${JUCE_LIBRARIES}
 		ICU::data ICU::uc
@@ -180,13 +197,30 @@ ELSEIF(APPLE)
 		gin
 		spdlog::spdlog
 		pybind11::embed
+	 	$<$<BOOL:${SPARKLE_UPDATES}>:${SPARKLE_LINK}>
 		)
-	SET_TARGET_PROPERTIES(KnobKraftOrm PROPERTIES MACOSX_BUNDLE_BUNDLE_NAME "KnobKraft Orm ${KnobKraftOrm_VERSION}"
+	SET_TARGET_PROPERTIES(KnobKraftOrm PROPERTIES
+			MACOSX_BUNDLE_BUNDLE_NAME "KnobKraft Orm ${KnobKraftOrm_VERSION}"
 			MACOSX_BUNDLE_ICON_FILE icon_orm.icns
 			MACOSX_BUNDLE_BUNDLE_VERSION ${KnobKraftOrm_VERSION}
 			MACOSX_BUNDLE_GUI_IDENTIFIER "com.knobkraft.orm"
 			MACOSX_BUNDLE_IDENTIFIER "com.knobkraft.orm"
-                )
+			MACOSX_BUNDLE_EXECUTABLE_NAME KnobKraftOrm
+			#MACOSX_BUNDLE_BUNDLE_VERSION ${KnobKraftOrm_VERSION}
+			MACOSX_BUNDLE_INFO_PLIST ${CMAKE_CURRENT_BINARY_DIR}/Info.plist
+			#XCODE_EMBED_FRAMEWORKS Sparkle
+			#XCODE_EMBED_FRAMEWORKS_CODE_SIGN_ON_COPY TRUE
+			#XCODE_EMBED_FRAMEWORKS_REMOVE_HEADERS_ON_COPY TRUE
+			)
+	# https://stackoverflow.com/questions/68310342/how-to-get-cmake-to-embed-a-private-framework-into-a-macos-app-bundle
+	set(APP_BUNDLE_CONTENTS_DIR "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.app/Contents")
+	set(APP_BUNDLE_FRAMEWORKS_DIR "${APP_BUNDLE_CONTENTS_DIR}/Frameworks")
+	configure_file("Info.plist.in" "Info.plist")
+
+	add_custom_command(TARGET ${PROJECT_NAME}
+			POST_BUILD COMMAND
+			install_name_tool -add_rpath "@executable_path/../Frameworks/"
+			"${APP_BUNDLE_CONTENTS_DIR}/MacOS/${PROJECT_NAME}")
 ELSEIF(UNIX)
 	target_link_libraries(KnobKraftOrm PRIVATE 
 		${JUCE_LIBRARIES} 
@@ -328,6 +362,11 @@ ENDIF()
 IF(APPLE)
 	# This section is supposed to build a relocatable macOS DMG installer when you specify the
 	# --target package
+	set(CMAKE_INSTALL_PREFIX ${CMAKE_BINARY_DIR})
+	IF(SPARKLE_UPDATES)
+		# Make sure the private frameworks are in out binary directory
+		file(COPY ${SPARKLE_FRAMEWORK_PATH}/Sparkle.framework DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/KnobKraftOrm.app/Contents/Frameworks)
+	ENDIF()
 
 	IF(CODESIGN_CERTIFICATE_NAME)
 		# We need to sign the files as a post build step. Doing this as install step doesn't help because

The-Orm/Info.plist.in

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist>
+  <dict>
+    <key>SUFeedURL</key>
+    <string>https://raw.githubusercontent.com/christofmuc/appcasts/master/KnobKraft-Orm/appcast.xml</string>
+    <key>SUPublicEDKey</key>
+    <string>MCowBQYDK2VwAyEAWtvaPXtAM9WMjFoaE6i5ZWBTZE929CUMlCB3NiXTo0g=</string>
+    <key>CFBundleExecutable</key>
+    <string>KnobKraftOrm</string>
+    <key>CFBundleIconFile</key>
+    <string>${MACOSX_BUNDLE_ICON_FILE}</string>
+    <key>CFBundleIdentifier</key>
+    <string>${MACOSX_BUNDLE_GUI_IDENTIFIER}</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>${MACOSX_BUNDLE_BUNDLE_NAME}</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>CFBundleShortVersionString</key>
+    <string>${MACOSX_BUNDLE_SHORT_VERSION_STRING}</string>
+    <key>CFBundleVersion</key>
+    <string>${MACOSX_BUNDLE_BUNDLE_VERSION}</string>
+    <!-- Minimum System Version (macOS version) -->
+    <key>LSMinimumSystemVersion</key>
+    <string>10.11</string>
+    <key>CFBundleSupportedPlatforms</key>
+    <array>
+      <string>MacOSX</string>
+    </array>  </dict>
+</plist>

The-Orm/MacSparkle.h

@@ -0,0 +1,21 @@
+/*
+   Copyright (c) 2022 Christof Ruch. All rights reserved.
+
+   Dual licensed: Distributed under Affero GPL license by default, an MIT license is available for purchase
+*/
+
+#pragma once
+
+#include "AutoUpdaterInterface.h"
+
+class SparkleAutoUpdate : public AutoUpdaterInterface
+{
+public:
+  SparkleAutoUpdate ();
+  virtual ~SparkleAutoUpdate ();
+  virtual void checkForUpdates();
+
+private:
+  class Impl;
+  Impl *d;
+};

The-Orm/MacSparkle.mm

@@ -0,0 +1,42 @@
+/*
+   Copyright (c) 2022 Christof Ruch. All rights reserved.
+
+   Dual licensed: Distributed under Affero GPL license by default, an MIT license is available for purchase
+*/
+
+#include "MacSparkle.h"
+
+#import <Foundation/Foundation.h>
+#import <Sparkle/Sparkle.h>
+
+// This does not follow the new procedure at https://sparkle-project.org/documentation/programmatic-setup/ yet
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
+class SparkleAutoUpdate::Impl
+{
+public:
+  SUUpdater *updater;
+};
+
+SparkleAutoUpdate::SparkleAutoUpdate()
+{
+  d = new SparkleAutoUpdate::Impl;
+  d->updater = [[SUUpdater sharedUpdater] retain];
+  [d->updater setAutomaticallyChecksForUpdates: YES];
+  [d->updater setUpdateCheckInterval: 3600];
+}
+
+SparkleAutoUpdate::~SparkleAutoUpdate()
+{
+  [d->updater release];
+  delete d;
+}
+
+void SparkleAutoUpdate::checkForUpdates()
+{
+  [d->updater checkForUpdates : nil];
+}
+
+#pragma clang diagnostic pop