Add windows arm64 build to CI (#1434)

tsteven4 · web-flow · commit e0c03a8967c4 · 2025-04-14T12:29:30.000-06:00
diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -45,23 +45,31 @@ jobs:
             METHOD: 'aqt'
             GENERATOR: 'Visual Studio 17 2022'
             RELEASE: false
-            os: windows-latest
+            os: windows-2022
           - QT_VERSION: '6.5.3'
             ARCH: 'amd64'
             HOST_ARCH: 'amd64'
             COMPILER: 'msvc2019_64'
             METHOD: 'aqt'
-            RELEASE: true
+            RELEASE: false
             GENERATOR: 'Ninja'
-            os: windows-latest
+            os: windows-2022
           - QT_VERSION: '6.8.3'
             ARCH: 'amd64'
             HOST_ARCH: 'amd64'
             COMPILER: 'msvc2022_64'
             METHOD: 'aqt'
-            RELEASE: false
+            RELEASE: true
             GENERATOR: 'Ninja'
             os: windows-2025
+          - QT_VERSION: '6.8.3'
+            TARGET_ARCH: 'arm64'
+            HOST_ARCH: 'amd64'
+            COMPILER: 'msvc2022_64'
+            CROSS_COMPILER: 'msvc2022_arm64'
+            METHOD: 'aqt'
+            RELEASE: true
+            os: windows-2025
 
     steps:
     - name: Checkout repository
@@ -72,7 +80,7 @@ jobs:
       id: cache
       with:
         path: ~/Cache
-        key: ${{ runner.os }}-${{ matrix.QT_VERSION }}-${{ matrix.COMPILER }}-${{ secrets.CACHE_VERSION }}
+        key: ${{ runner.os }}-${{ matrix.QT_VERSION }}-${{ matrix.COMPILER }}-${{ matrix.CROSS_COMPILER }}-${{ secrets.CACHE_VERSION }}
 
     - name: Install Qt setup(aqt)
       if: steps.cache.outputs.cache-hit != 'true'
@@ -86,7 +94,11 @@ jobs:
         CI_BUILD_DIR: ${{ github.workspace }}
       shell: bash
       run: |
-        ./tools/ci_install_windows.sh "${{ matrix.QT_VERSION }}" "${{ matrix.COMPILER }}" "${{ matrix.METHOD }}"
+        if [ -n "${{ matrix.CROSS_COMPILER }}" ]; then
+          ./tools/ci_install_windows.sh "${{ matrix.QT_VERSION }}" "${{ matrix.COMPILER }}" "${{ matrix.METHOD }}" "${{ matrix.CROSS_COMPILER }}"
+        else
+          ./tools/ci_install_windows.sh "${{ matrix.QT_VERSION }}" "${{ matrix.COMPILER }}" "${{ matrix.METHOD }}"
+        fi
 
     - name: Install Inno Setup
       if: matrix.os == 'windows-2025'
@@ -95,18 +107,31 @@ jobs:
     - name: Build
       shell: powershell
       run: |
-        .\tools\ci_setup_windows.ps1 -qtdir "$Home\Cache\Qt\${{ matrix.QT_VERSION }}\${{ matrix.COMPILER }}" -arch "${{ matrix.ARCH }}" -host_arch "${{ matrix.HOST_ARCH }}" -vcversion "${{ matrix.VCVERSION }}"
-        .\tools\ci_script_windows.ps1 -generator "${{ matrix.GENERATOR }}" -arch "${{ matrix.ARCH }}" -toolset "${{ matrix.TOOLSET }}"
+        if ([string]::IsNullOrEmpty("${{  matrix.CROSS_COMPILER }}")) {
+          .\tools\ci_setup_windows.ps1 -qtdir "$Home\Cache\Qt\${{ matrix.QT_VERSION }}\${{ matrix.COMPILER }}" -arch "${{ matrix.ARCH }}" -host_arch "${{ matrix.HOST_ARCH }}" -vcversion "${{ matrix.VCVERSION }}"
+          .\tools\ci_script_windows.ps1 -generator "${{ matrix.GENERATOR }}" -arch "${{ matrix.ARCH }}" -toolset "${{ matrix.TOOLSET }}"
+        } else {
+          $hash = @{}
+          $hash["qt_root_dir"] = "$Home\Cache\Qt\${{ matrix.QT_VERSION }}"
+          $hash["host_arch"] = "${{ matrix.HOST_ARCH }}"
+          $hash["target_arch"] = "${{ matrix.TARGET_ARCH }}"
+          $hash["compiler"] = "${{ matrix.COMPILER }}"
+          $hash["cross_compiler"] = "${{ matrix.CROSS_COMPILER }}"
+          .\tools\ci_windows_cross_compile @hash
+        }
 
     - name: Rename
       shell: bash
       run: |
         VERSION_ID=$(date -u +%Y%m%dT%H%MZ --date=$(git show -s --format=%aI HEAD))-$(git rev-parse --short=7 HEAD)
-        mv bld/gui/GPSBabel-*-Setup.exe bld/gui/GPSBabel-${VERSION_ID}-Setup.exe
-        mv bld/gui/GPSBabel-*-Manifest.txt bld/gui/GPSBabel-${VERSION_ID}-Manifest.txt
+        SETUP=$(ls bld/gui/GPSBabel-*-Setup-*.exe | sed "s/\([^-]*\)-\([^-]*\)-\(.*\)/\1-${VERSION_ID}-\3/")
+        mv bld/gui/GPSBabel-*-Setup-*.exe ${SETUP}
+        MANIFEST=$(ls bld/gui/GPSBabel-*-Manifest-*.txt | sed "s/\([^-]*\)-\([^-]*\)-\(.*\)/\1-${VERSION_ID}-\3/")
+        mv bld/gui/GPSBabel-*-Manifest-*.txt ${MANIFEST}
 
     - name: Test
       shell: bash
+      if: matrix.CROSS_COMPILER == ''
       run: |
         # PATH="${HOME}/Cache/Qt/${{ matrix.QT_VERSION }}/${{ matrix.COMPILER }}/bin:${PATH}"
         PNAME=./bld/gui/package/gpsbabel.exe GBTEMP=./gbtemp ./testo 2>&1
@@ -116,7 +141,7 @@ jobs:
       if: ${{ inputs.attestation && matrix.RELEASE }}
       uses: actions/attest-build-provenance@v2
       with:
-        subject-path: 'bld/gui/GPSBabel-*-Setup.exe'
+        subject-path: 'bld/gui/GPSBabel-*-Setup-*.exe'
 
     - name: Deploy
       # This only handles continous releases now, for other events artifacts may be saved in
@@ -127,13 +152,13 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         RELEASE_NAME: Continuous-${{ runner.os }}
       run: |
-        ./tools/uploadtool/upload_github.sh bld/gui/GPSBabel-*-Setup.exe
+        ./tools/uploadtool/upload_github.sh bld/gui/GPSBabel-*-Setup-*.exe
 
     - name: 'Upload Artifacts'
       uses: actions/upload-artifact@v4
       with:
         name: Windows_Installer ${{ join(matrix.*) }}
         path: |
-          bld/gui/GPSBabel-*-Setup.exe
-          bld/gui/GPSBabel-*-Manifest.txt
+          bld/gui/GPSBabel-*-Setup-*.exe
+          bld/gui/GPSBabel-*-Manifest-*.txt
         retention-days: 7
diff --git a/gui/CMakeLists.txt b/gui/CMakeLists.txt
@@ -230,16 +230,31 @@ else()
     if((NOT WINDEPLOYQT STREQUAL "WINDEPLOYQT-NOTFOUND") AND (NOT INNO_COMPILER STREQUAL "INNO_COMPILER-NOTFOUND"))
       file(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}" _win_binary_path)
       file(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}" _win_source_path)
+      # for cross compiles we need to tell windeployqt about the target qt paths.
+      if(CMAKE_TOOLCHAIN_FILE)
+        get_filename_component(_qt_toolchain_dir ${CMAKE_TOOLCHAIN_FILE} DIRECTORY)
+        get_filename_component(_qt_target_bin_dir ${_qt_toolchain_dir}/../../../bin ABSOLUTE)
+        file(TO_NATIVE_PATH "${_qt_target_bin_dir}/qtpaths.bat" _qtpaths_file)
+        set(_qtpaths_option --qtpaths "${_qtpaths_file}")
+        message(STATUS "Deploying with target qtpaths \"${_qtpaths_file}\".")
+      endif()
+      # generate architecture for inno setup
+      if(CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64" OR CMAKE_SYSTEM_PROCESSOR STREQUAL "ARM64")
+        set(_installer_arch arm64)
+      else()
+        set(_installer_arch x64compatible)
+      endif()
+      message(STATUS "CMAKE_SYSTEM_PROCESSOR is \"${CMAKE_SYSTEM_PROCESSOR}\".  Building installer for architecture identifier \"${_installer_arch}\".")
       add_custom_target(package_app
                         # deploy to a clean directory as different build systems create differently named debris in release.
                         COMMAND ${CMAKE_COMMAND} -E remove_directory package
                         COMMAND ${CMAKE_COMMAND} -E make_directory package
                         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:gpsbabelfe> package
                         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:gpsbabel> package
                         # use --plugindir option to locate the plugins.
-                        COMMAND ${WINDEPLOYQT} --verbose 1 --plugindir package\\plugins package\\GPSBabelFE.exe package\\GPSBabel.exe
+                        COMMAND ${WINDEPLOYQT} --verbose 1 --plugindir package\\plugins package\\GPSBabelFE.exe package\\GPSBabel.exe ${_qtpaths_option}
                         # set location to location of generated setup.iss file.
-                        COMMAND ${INNO_COMPILER} /Doutput_dir=${_win_binary_path} /Dsource_dir=${_win_source_path} setup.iss
+                        COMMAND ${INNO_COMPILER} /Doutput_dir=${_win_binary_path} /Dsource_dir=${_win_source_path} /Darch=${_installer_arch} setup.iss
                         DEPENDS gpsbabelfe gpsbabel gpsbabelfe_lrelease coretool_lrelease
                         VERBATIM
                         USES_TERMINAL)
diff --git a/gui/setup.iss.in b/gui/setup.iss.in
@@ -13,6 +13,9 @@
 #ifndef source_dir
   #define source_dir "."
 #endif
+#ifndef arch
+  #define arch "x64compatible"
+#endif
 
 [Setup]
 ; NOTE: The value of AppId uniquely identifies this application.
@@ -25,13 +28,13 @@ AppPublisher=GPSBabel
 AppPublisherURL=https://www.gpsbabel.org
 AppSupportURL=https://www.gpsbabel.org
 AppUpdatesURL=https://www.gpsbabel.org
-ArchitecturesAllowed=x64
-ArchitecturesInstallIn64BitMode=x64
-DefaultDirName={pf}\GPSBabel
+ArchitecturesAllowed={#arch}
+ArchitecturesInstallIn64BitMode={#arch}
+DefaultDirName={commonpf}\GPSBabel
 DefaultGroupName=GPSBabel
 OutputDir="{#output_dir}"
-OutputBaseFilename=GPSBabel-@GB.VERSION@@GB.PACKAGE_RELEASE@-Setup
-OutputManifestFile=GPSBabel-@GB.VERSION@@GB.PACKAGE_RELEASE@-Manifest.txt
+OutputBaseFilename=GPSBabel-@GB.VERSION@@GB.PACKAGE_RELEASE@-Setup-{#arch}
+OutputManifestFile=GPSBabel-@GB.VERSION@@GB.PACKAGE_RELEASE@-Manifest-{#arch}.txt
 SetupIconFile=images\babel2.ico
 Compression=lzma
 SolidCompression=yes
diff --git a/tools/ci_install_windows.sh b/tools/ci_install_windows.sh
@@ -19,8 +19,9 @@ function validate() {
 }
 
 QT_VERSION=${1:-6.5.3}
-COMPILER=${2:-msvc2019_64}
+COMPILER=${2:-msvc2022_64}
 METHOD=${3:-default}
+CROSS_COMPILER=${4}
 
 if [ "${COMPILER}" = "msvc2017_64" ]; then
   PACKAGE_SUFFIX=win64_msvc2017_64
@@ -37,6 +38,15 @@ else
   exit 1
 fi
 
+if [ -n "${CROSS_COMPILER}" ]; then
+  if [ "${CROSS_COMPILER}" = "msvc2022_arm64" ]; then
+    PACKAGE_SUFFIX_CROSS=win64_msvc2022_arm64_cross_compiled
+  else
+    echo "ERROR: unrecognized Qt cross compiler ${CROSS_COMPILER}." >&2
+    exit 1
+  fi
+fi
+
 CACHEDIR=${HOME}/Cache
 QTDIR=${CACHEDIR}/Qt/${QT_VERSION}/${COMPILER}
 
@@ -49,6 +59,9 @@ else
   if [ "${METHOD}" = "aqt" ]; then
     pip3 install 'aqtinstall>=3.1.20'
     "${CI_BUILD_DIR}/tools/ci_install_qt.sh" windows "${QT_VERSION}" "${PACKAGE_SUFFIX}" "${CACHEDIR}/Qt"
+    if [ -n "${PACKAGE_SUFFIX_CROSS}" ]; then
+      "${CI_BUILD_DIR}/tools/ci_install_qt.sh" windows "${QT_VERSION}" "${PACKAGE_SUFFIX_CROSS}" "${CACHEDIR}/Qt"
+    fi
     echo "export PATH=${QTDIR}/bin:\$PATH" > "${CACHEDIR}/qt.env"
   else
     echo "ERROR: unknown installation method ${METHOD}." >&2
diff --git a/tools/ci_windows_cross_compile.ps1 b/tools/ci_windows_cross_compile.ps1
@@ -0,0 +1,30 @@
+Param(
+    $build_dir_name = "bld",
+    $qt_root_dir = "C:/Qt/6.8.3",
+    $host_arch = "amd64",
+    $target_arch = "arm64",
+    $compiler = "msvc2022_64",
+    $cross_compiler = "msvc2022_arm64"
+)
+
+$ErrorActionPreference = "Stop"
+
+# setup visual studio development envirnonment
+$vswhere = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe"
+$installationPath = & "$vswhere" -latest -property installationPath
+& "$installationPath\Common7\Tools\Launch-VsDevShell.ps1" -Arch $target_arch -HostArch $host_arch -SkipAutomaticLocation
+
+$src_dir = $Pwd
+$build_dir = Join-Path $src_dir $build_dir_name
+
+# make sure we are staring with a clean build directory
+Remove-Item $build_dir -Recurse -ErrorAction Ignore
+New-Item $build_dir -type directory -Force | Out-Null
+Set-Location $build_dir
+
+$toolchain_file = "$qt_root_dir/$cross_compiler/lib/cmake/Qt6/qt.toolchain.cmake"
+$qt_host_path = "$qt_root_dir/$compiler"
+cmake -G Ninja -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_TOOLCHAIN_FILE:FILEPATH="$toolchain_file" -DQT_HOST_PATH:PATH="$qt_host_path" "$src_dir"
+if ($LastExitCode -ne 0) { $host.SetShouldExit($LastExitCode) }
+cmake --build "$build_dir" --target package_app
+if ($LastExitCode -ne 0) { $host.SetShouldExit($LastExitCode) }
