Skip to content

CMake: Fix MacOS Deployment Issues #13004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ jobs:
ARTIFACT: QGroundControl.dmg
PACKAGE: QGroundControl
QT_VERSION: 6.8.3
QGC_MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}

steps:
- name: Checkout repo
Expand Down
12 changes: 7 additions & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,8 @@ elseif(APPLE)
set(CMAKE_XCODE_ATTRIBUTE_CODE_SIGN_ENTITLEMENTS "${QGC_MACOS_ENTITLEMENTS_PATH}")
endif()

cmake_path(GET QGC_MACOS_ICON_PATH FILENAME MACOSX_BUNDLE_ICON_FILE)

set_target_properties(${CMAKE_PROJECT_NAME}
PROPERTIES
MACOSX_BUNDLE TRUE
Expand All @@ -378,13 +380,13 @@ elseif(APPLE)
)

if(MACOS)
set(MACOSX_BUNDLE_ICON_FILE "macx.icns")
set(app_icon_macos "${QGC_MACOS_ICON_PATH}/${MACOSX_BUNDLE_ICON_FILE}")
set(app_icon_macos "${QGC_MACOS_ICON_PATH}")
set_source_files_properties(${app_icon_macos} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
target_sources(${CMAKE_PROJECT_NAME} PRIVATE ${app_icon_macos})
target_sources(${CMAKE_PROJECT_NAME} PRIVATE "${app_icon_macos}")

set_source_files_properties(${QGC_MACOS_ENTITLEMENTS_PATH} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
target_sources(${CMAKE_PROJECT_NAME} PRIVATE ${QGC_MACOS_ENTITLEMENTS_PATH})
set(app_entitlements_macos "${QGC_MACOS_ENTITLEMENTS_PATH}")
set_source_files_properties(${app_entitlements_macos} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
target_sources(${CMAKE_PROJECT_NAME} PRIVATE "${app_entitlements_macos}")
elseif(IOS)
enable_language(OBJC)

Expand Down
11 changes: 5 additions & 6 deletions cmake/CreateMacDMG.cmake
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

set(STAGING_BUNDLE_PATH ${CMAKE_BINARY_DIR}/staging/${TARGET_APP_NAME}.app)

message(STATUS "Signing bundle: ${STAGING_BUNDLE_PATH}")
message(STATUS "Signing bundle: ${QGC_BUNDLE_PATH}")
execute_process(
COMMAND codesign --force --deep -s - "${STAGING_BUNDLE_PATH}"
COMMAND codesign --force --deep -s - "${QGC_BUNDLE_PATH}"
COMMAND_ECHO STDOUT
COMMAND_ERROR_IS_FATAL ANY
)

file(REMOVE_RECURSE ${CMAKE_BINARY_DIR}/package)
file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/package)
file(COPY ${STAGING_BUNDLE_PATH} DESTINATION ${CMAKE_BINARY_DIR}/package)
file(COPY ${QGC_BUNDLE_PATH} DESTINATION ${CMAKE_BINARY_DIR}/package)

message(STATUS "Creating DMG: ${TARGET_APP_NAME}.dmg")
execute_process(
COMMAND create-dmg --volname "${TARGET_APP_NAME}" --filesystem "APFS" "${TARGET_APP_NAME}.dmg" "${CMAKE_BINARY_DIR}/package/"
COMMAND_ECHO STDOUT
COMMAND_ERROR_IS_FATAL ANY
)
6 changes: 3 additions & 3 deletions cmake/CustomOptions.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ option(QT_USE_TARGET_ANDROID_BUILD_DIR "Use Target Android Build Dir" OFF)

# MacOS
set(QGC_MACOS_PLIST_PATH "${CMAKE_SOURCE_DIR}/deploy/macos/MacOSXBundleInfo.plist.in" CACHE FILEPATH "MacOS PList Path")
set(QGC_MACOS_BUNDLE_ID "org.qgroundcontrol.QGroundControl" CACHE STRING "MacOS Bundle ID") # MACOS
set(QGC_MACOS_ICON_PATH "${CMAKE_SOURCE_DIR}/deploy/macos" CACHE PATH "MacOS Icon Path") # MACOS
set(QGC_MACOS_BUNDLE_ID "${QGC_PACKAGE_NAME}" CACHE STRING "MacOS Bundle ID")
set(QGC_MACOS_ICON_PATH "${CMAKE_SOURCE_DIR}/deploy/macos/qgroundcontrol.icns" CACHE FILEPATH "MacOS Icon Path")
set(QGC_MACOS_ENTITLEMENTS_PATH "${CMAKE_SOURCE_DIR}/deploy/macos/qgroundcontrol.entitlements" CACHE FILEPATH "MacOS Entitlements Path")
# option(QGC_MACOS_UNIVERSAL_BUILD "Build MacOS Universal Build (arm64;x86_64)" ON) # MACOS
# option(QGC_MACOS_UNIVERSAL_BUILD "Build MacOS Universal Build (arm64;x86_64)" ON)

# Linux
set(QGC_APPIMAGE_ICON_PATH "${CMAKE_SOURCE_DIR}/resources/icons/qgroundcontrol.png" CACHE FILEPATH "AppImage Icon Path")
Expand Down
22 changes: 9 additions & 13 deletions cmake/Install.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,21 @@ install(
)

set(deploy_tool_options_arg "")
if(MACOS OR WIN32)
set(deploy_tool_options_arg "-qmldir=${CMAKE_SOURCE_DIR}")
if(MACOS_SIGNING_IDENTITY)
if(Qt6_VERSION VERSION_GREATER_EQUAL 6.7.0 AND (MACOS OR WIN32))
set(deploy_tool_options_arg -qmldir="${CMAKE_SOURCE_DIR}/src/QMLControls")
if(MACOS AND DEFINED ENV{QGC_MACOS_SIGNING_IDENTITY})
message(STATUS "Signing MacOS Bundle")
set(deploy_tool_options_arg "${deplay_tool_options_arg} -sign-for-notarization=${MACOS_SIGNING_IDENTITY}")
list(APPEND deploy_tool_options_arg -sign-for-notarization=$ENV{QGC_MACOS_SIGNING_IDENTITY})
endif()
endif()

# Set extra deploy QML app script options for Qt 6.7.0 and above
set(EXTRA_DEPLOY_QML_APP_SCRIPT_OPTIONS)
if(Qt6_VERSION VERSION_GREATER_EQUAL 6.7.0)
list(APPEND EXTRA_DEPLOY_QML_APP_SCRIPT_OPTIONS DEPLOY_TOOL_OPTIONS ${deploy_tool_options_arg})
endif()

qt_generate_deploy_qml_app_script(
TARGET ${CMAKE_PROJECT_NAME}
OUTPUT_SCRIPT deploy_script
${EXTRA_DEPLOY_QML_APP_SCRIPT_OPTIONS}
MACOS_BUNDLE_POST_BUILD
NO_UNSUPPORTED_PLATFORM_ERROR
DEPLOY_USER_QML_MODULES_ON_UNSUPPORTED_PLATFORM
DEPLOY_TOOL_OPTIONS ${deploy_tool_options_arg}
)
install(SCRIPT ${deploy_script})

Expand Down Expand Up @@ -75,7 +69,9 @@ elseif(WIN32)
install(CODE "set(QGC_WINDOWS_INSTALLER_SCRIPT ${CMAKE_SOURCE_DIR}/deploy/windows/nullsoft_installer.nsi)")
install(SCRIPT "${CMAKE_SOURCE_DIR}/cmake/CreateWinInstaller.cmake")
elseif(MACOS)
install(CODE "set(TARGET_APP_NAME ${QGC_APP_NAME})")
install(CODE "set(MACDEPLOYQT ${Qt6_DIR}/../../../bin/macdeployqt)")
install(CODE "
set(QGC_BUNDLE_PATH $<TARGET_BUNDLE_DIR:${CMAKE_PROJECT_NAME}>)
set(TARGET_APP_NAME ${CMAKE_PROJECT_NAME})
")
install(SCRIPT "${CMAKE_SOURCE_DIR}/cmake/CreateMacDMG.cmake")
endif()
5 changes: 4 additions & 1 deletion custom-example/cmake/CustomOverrides.cmake
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
set(QGC_APP_NAME "Custom-QGroundControl" CACHE STRING "App Name" FORCE)

set(QGC_MACOS_ICON_PATH "${CMAKE_SOURCE_DIR}/custom/res" CACHE PATH "MacOS Icon Path" FORCE)
if(EXISTS "${CMAKE_SOURCE_DIR}/custom/res/custom_qgroundcontrol.icns")
set(QGC_MACOS_ICON_PATH "${CMAKE_SOURCE_DIR}/custom/custom_qgroundcontrol.icns" CACHE FILEPATH "MacOS Icon Path" FORCE)
endif()

set(QGC_APPIMAGE_ICON_PATH "${CMAKE_SOURCE_DIR}/custom/res/icons/custom_qgroundcontrol.png" CACHE FILEPATH "AppImage Icon Path" FORCE)

if(EXISTS ${CMAKE_SOURCE_DIR}/custom/deploy/windows/installheader.bmp)
Expand Down
2 changes: 2 additions & 0 deletions deploy/macos/qgroundcontrol.entitlements
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,7 @@
<dict>
<key>com.apple.security.app-sandbox</key>
<true/>
<key>com.apple.security.network.client</key>
<true/>
</dict>
</plist>
File renamed without changes.
Loading