main.yml

name: CI

on:
  push:
  pull_request:
    branches:
      - main

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  test:
    name: Build and test
    runs-on: windows-2019
    timeout-minutes: 20
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev"]
        architecture: ["x64", "x86"]

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          architecture: ${{ matrix.architecture }}
          cache: pip
          cache-dependency-path: .github/workflows/main.yml
          check-latest: true

      - name: Setup environment
        run: |
          python --version
          pip --version
          pip install --upgrade setuptools>=74 wheel

      - name: Build and install
        run: |
          python setup.py install --user

      # This needs to happen *after* installing pywin32 since
      # AutoDuck/py2d.py currently relies on runtime imports for introspection
      # This isn't included in the wheel (TODO: could we?)
      # and only servces as a PR test for the docs.yaml workflow
      - name: Generate PyWin32.chm help file
        run: python AutoDuck/make.py

      - name: Run tests
        # Run the tests directly from the source dir so support files (eg, .wav files etc)
        # can be found - they aren't installed into the Python tree.
        run: python pywin32_testall.py -v -skip-adodbapi

      - name: Build wheels
        run: |
          python setup.py bdist_wheel --skip-build

      - uses: actions/upload-artifact@v3
        if: ${{ always() }}
        with:
          name: artifacts
          path: |
            dist/*.whl
            dist/*.exe

  # 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:
    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-dev"]
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          architecture: "x64"
          cache: pip
          cache-dependency-path: .github/workflows/main.yml
          check-latest: true

      - name: Setup Environment
        run: |
          python --version
          pip --version
          pip install --upgrade setuptools>=74 wheel

      - name: Obtain ARM64 library files
        run: |
          python .github\workflows\download-arm64-libs.py .\arm64libs

      - name: Build wheels
        run: python setup.py build_ext -L .\arm64libs --plat-name win-arm64 build --plat-name win-arm64 bdist_wheel --plat-name win-arm64

      - uses: actions/upload-artifact@v3
        if: ${{ always() }}
        with:
          name: artifacts
          path: |-
            dist/*.whl

  # This job can be run locally by running `pre-commit run`
  checkers:
    runs-on: windows-2019
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          # This job only needs to target the oldest supported version
          python-version: "3.8"
          cache: pip
          cache-dependency-path: .github/workflows/main.yml
      - run: pip install clang-format pycln
      - run: pycln . --config=pycln.toml --check
      - uses: astral-sh/ruff-action@v1
        with:
          version: "0.4.9"
      - uses: astral-sh/ruff-action@v1
        with:
          version: "0.4.9"
          args: "format --check"
      - run: | # Too many files to fit in a single command, also exclude vendored Scintilla and MAPIStubLibrary
          clang-format --Werror --dry-run $(git ls-files '*.cpp')
          clang-format --Werror --dry-run $(git ls-files '*.h' ':!:Pythonwin/Scintilla/' ':!:com/win32comext/mapi/src/MAPIStubLibrary/')

  mypy:
    runs-on: windows-2019
    timeout-minutes: 20
    strategy:
      fail-fast: false
      matrix:
        # mypy won't understand "3.13-dev", keeping the CI simple by just omitting it
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
          cache-dependency-path: .github/workflows/main.yml
          check-latest: true
      - run: pip install types-setuptools PyOpenGL mypy==1.11
      - run: mypy . --python-version=${{ matrix.python-version }}

  pyright:
    runs-on: windows-2019
    timeout-minutes: 20
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev"]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip
          cache-dependency-path: .github/workflows/main.yml
          check-latest: true
      # pyright vendors typeshed, but let's make sure we have the most up to date stubs
      - run: pip install types-setuptools PyOpenGL
      - uses: jakebailey/pyright-action@v2
        with:
          python-version: ${{ matrix.python-version }}
          version: "1.1.358"
          annotate: errors