Native ARM64 CI tests and wheels

Author: Avasam

.github/workflows/main.yml

@@ -17,13 +17,23 @@ env:
 jobs:
   test:
     name: Build and test
-    runs-on: windows-2019
-    timeout-minutes: 20
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 25
     strategy:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
-        architecture: ["x64", "x86"]
+        # CPython has no ARM distribution until 3.11
+        python-architecture: [x64, x86]
+        os: [windows-2019, windows-11-arm]
+        exclude:
+          - os: windows-11-arm
+            python-architecture: x86
+        # python-architecture: [x64, x86, arm64]
+        # include:
+        #   - python-architecture: arm64
+        #     os: windows-11-arm
+        #   - os: windows-2019
 
     steps:
       - uses: actions/checkout@v4
@@ -32,13 +42,13 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          architecture: ${{ matrix.architecture }}
+          architecture: ${{ matrix.python-architecture }}
           cache: pip
           cache-dependency-path: .github/workflows/main.yml
           check-latest: true
 
       - name: Fix user Scripts missing from PATH
-        if: matrix.architecture == 'x86'
+        if: matrix.python-architecture == 'x86'
         run: |
           # Work around https://github.com/actions/setup-python/issues/1005
           $ScriptsPath = python -c "import sysconfig,os; print(sysconfig.get_path('scripts', f'{os.name}_user'))"
@@ -65,12 +75,28 @@ jobs:
       # Compilation and registration of the PyCOMTest server dll
       - name: Set up MSVC
         uses: microsoft/setup-msbuild@v2
+
+      # See https://github.com/actions/runner-images/issues/9701
+      # Adapted from https://github.com/actions/runner-images/issues/9873#issuecomment-2139288682
+      - name: Install missing Visual Studio components
+        if: matrix.os != 'windows-2019' # Only an issue on newer versions of Windows
+        run: |
+          Set-Location "C:\Program Files (x86)\Microsoft Visual Studio\Installer\"
+          $VsInstallPath = vswhere.exe -latest -products * -requires Microsoft.Component.MSBuild -property installationPath
+          [string]$ComponentsToAdd = @(
+            "Microsoft.VisualStudio.Component.VC.14.29.16.11.ATL"
+            "Microsoft.VisualStudio.Component.VC.14.29.16.11.ATL.ARM64"
+          ) | ForEach-Object {"--add $_"}
+          $ArgumentList = ('modify', '--installPath', "`"$VsInstallPath`"", $ComponentsToAdd, '--quiet', '--norestart', '--nocache')
+          echo "vs_installer.exe $($ArgumentList -join ' ')"
+          # should be run twice for some reason
+          Start-Process -FilePath vs_installer.exe -ArgumentList $ArgumentList -Wait -PassThru -WindowStyle Hidden
+          Start-Process -FilePath vs_installer.exe -ArgumentList $ArgumentList -Wait -PassThru -WindowStyle Hidden
+
       - name: Build and register the PyCOMTest server dll
         run: |
-          cd com/TestSources/PyCOMTest
-          msbuild .\PyCOMTest.sln -property:Configuration=Release
-          cd x64/Release
-          regsvr32 .\PyCOMTest.dll
+          msbuild com/TestSources/PyCOMTest/PyCOMTest.sln -property:Configuration=Release
+          regsvr32 com/TestSources/PyCOMTest/x64/Release/PyCOMTest.dll
 
       - name: Run tests
         # Run the tests directly from the source dir so support files (eg, .wav files etc)
@@ -84,28 +110,23 @@ jobs:
         # Upload artifacts even if tests fail
         if: ${{ always() }}
         with:
-          name: artifacts-${{ matrix.python-version }}-${{ matrix.architecture }}
+          name: artifacts-${{ matrix.python-version }}-${{ matrix.python-architecture }}-${{ matrix.os }}
           path: dist/*.whl
           if-no-files-found: error
 
-  # We cannot build and test on ARM64, so we cross-compile.
-  # Later, when available, we can add tests using this wheel on ARM64 VMs
-  build_arm64:
+  # Do a single ARM64 cross-compilation to ensure we still support it
+  test_cross_compile:
     name: Cross-compile ARM
     runs-on: windows-2019
-    timeout-minutes: 20
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    timeout-minutes: 25
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up latest stable Python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
-          architecture: "x64"
+          python-version: 3.x
+          architecture: x64
           cache: pip
           cache-dependency-path: .github/workflows/main.yml
           check-latest: true
@@ -119,15 +140,9 @@ jobs:
       - name: Build wheels
         run: python -m build --wheel --config-setting=--build-option=build_ext --config-setting=--build-option=-L.\arm64libs --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=build --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=bdist_wheel --config-setting=--build-option=--plat-name=win-arm64
 
-      - uses: actions/upload-artifact@v4
-        with:
-          name: artifacts-${{ matrix.python-version }}-arm64
-          path: dist/*.whl
-          if-no-files-found: error
-
   merge:
     runs-on: windows-latest
-    needs: [test, build_arm64]
+    needs: [test]
     steps:
       - name: Merge Artifacts
         uses: actions/upload-artifact/merge@v4
@@ -142,7 +157,7 @@ jobs:
   # This job can be run locally by running `pre-commit run`
   checkers:
     runs-on: windows-2019
-    timeout-minutes: 20
+    timeout-minutes: 25
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -157,15 +172,16 @@ jobs:
         with:
           version: "0.8.4"
       - run: ruff format --check
-      - run: | # Too many files to fit in a single command, also exclude vendored Scintilla and MAPIStubLibrary
+      # Too many files to fit in a single command, also exclude vendored Scintilla and MAPIStubLibrary
+      - run: |
           clang-format --Werror --dry-run $(git ls-files '*.cpp' ':!:com/win32comext/mapi/src/MAPIStubLibrary/')
           if ($LastExitCode -ne 0) { exit $LastExitCode }
           clang-format --Werror --dry-run $(git ls-files '*.h' ':!:Pythonwin/Scintilla/' ':!:com/win32comext/mapi/src/MAPIStubLibrary/')
           if ($LastExitCode -ne 0) { exit $LastExitCode }
 
   mypy:
     runs-on: windows-2019
-    timeout-minutes: 20
+    timeout-minutes: 25
     strategy:
       fail-fast: false
       matrix:
@@ -183,7 +199,7 @@ jobs:
 
   pyright:
     runs-on: windows-2019
-    timeout-minutes: 20
+    timeout-minutes: 25
     strategy:
       fail-fast: false
       matrix:

make_all.bat

@@ -25,7 +25,7 @@ py -3.12 -m build --wheel
 py -3.13-32 -m build --wheel
 py -3.13 -m build --wheel
 
-rem Check /build_env.md#build-environment to make sure you have all the required ARM64 components installed
+rem Check /build_env.md#cross-compiling-for-arm64-microsoft-visual-c-141-and-up to make sure you have all the required ARM64 components installed
 py -3.10 -m build --wheel --config-setting=--build-option=build_ext --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=build --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=bdist_wheel --config-setting=--build-option=--plat-name=win-arm64
 py -3.11 -m build --wheel --config-setting=--build-option=build_ext --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=build --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=bdist_wheel --config-setting=--build-option=--plat-name=win-arm64
 py -3.12 -m build --wheel --config-setting=--build-option=build_ext --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=build --config-setting=--build-option=--plat-name=win-arm64 --config-setting=--build-option=bdist_wheel --config-setting=--build-option=--plat-name=win-arm64