ci-build.yml

#---------------------------------------------------------------------------
# This workflow will build and archive a wxPython source distribution for
# CI. It will start by building a sdist archive first, and then that will be
# used in subsequent jobs on each supported platform and Python version.
#---------------------------------------------------------------------------

name: ci-build

on:
  # Trigger on push or PRs targeting the master branch
  push:
    branches: [ 'master' ]
    tags:
      - 'wxPython-*'
  pull_request:
    branches: [ 'master' ]

  # Also allow manual triggering (via web ui)
  workflow_dispatch:

# Cancel the workflow if another instance in the same workflow and PR is triggered
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

defaults:
  run:
    # always use bash shell, even on windows
    shell: bash

env:
  PYTHONUNBUFFERED: 1
  WXPYTHON_BUILD_ARGS: ${{ startsWith(github.ref, 'refs/tags/') && '--release' || '' }}

#---------------------------------------------------------------------------

jobs:
  # Build a wxPython source archive, and save it as an artifact for use in the
  # job that builds the wheels.
  build-source-dist:
    runs-on: ubuntu-24.04

    outputs:
      VERSION: ${{ steps.generate.outputs.version }}

    steps:
      - name: Checkout repo
        uses: actions/checkout@v6
        with:
          submodules: 'recursive'
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.13'
          cache: 'pip'

      - name: Install dependencies
        run: |
          sudo apt-get install -y gettext
          python -m pip install --upgrade -r requirements.txt

      - name: Generate wrapper code
        id: generate
        run: |
          python build.py setrev dox etg sip --nodoc
          VERSION=$(python build.py --quiet version)
          echo "version=$VERSION" >> "$GITHUB_OUTPUT"

      - name: Create source distribution (sdist)
        run: |
          python build.py sdist

      - name: Save sdist as job artifact
        uses: actions/upload-artifact@v7
        with:
          name: wxPython-source
          path: dist/wxpython-${{ steps.generate.outputs.version }}.tar.gz

      - name: Create demo source distribution (sdist_demo)
        if: github.event_name == 'push'
        run: |
          python build.py sdist_demo

      - name: Save demo sdist as job artifact
        if: github.event_name == 'push'
        uses: actions/upload-artifact@v7
        with:
          name: demo
          path: dist/wxPython-demo-${{ steps.generate.outputs.version }}.tar.gz


#---------------------------------------------------------------------------

  # Use pip and the wxPython-source artifact to build a wxPython wheel for every
  # supported Python version and architecture.
  build-wheels:
    # wait for prior job to complete
    needs: build-source-dist
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-24.04, windows-2025, macos-15-intel, macos-15, windows-11-arm ]
        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
        architecture: [ 'x86', 'x64', 'arm64' ]
        # Exclude x86 configs on non-Windows OSs
        exclude:
          - os: ubuntu-24.04
            architecture: x86
          - os: ubuntu-24.04
            architecture: arm64
          - os: macos-15-intel
            architecture: x86
          - os: macos-15-intel
            architecture: arm64
          - os: macos-15
            architecture: x86
          - os: macos-15
            architecture: x64
          - os: windows-2025
            architecture: arm64
          - os: windows-11-arm
            architecture: x86
          - os: windows-11-arm
            architecture: x64
          # Only build oldest and newest Pythons on PRs
          - python-version: ${{ github.event_name == 'pull_request' && '3.11' }}
          - python-version: ${{ github.event_name == 'pull_request' && '3.12' }}
          - python-version: ${{ github.event_name == 'pull_request' && '3.13' }}
          # Skip Windows x86 builds on PRs
          - architecture: ${{ github.event_name == 'pull_request' && 'x86' }}
          # Only build windows-11-arm on pushes
          - os: ${{ github.event_name != 'push' && 'windows-11-arm' }}
          # Python interpreter < 3.11 doesn't exist for Windows 11 ARM
          - os: windows-11-arm
            python-version: '3.10'

    env:
      VERSION: ${{ needs.build-source-dist.outputs.VERSION }}

    runs-on: ${{ matrix.os }}

    outputs:
      short_name: ${{ steps.init.outputs.short_name }}
      canonical_id: ${{ steps.init.outputs.canonical_id }}

    steps:
      - name: initialize variables
        id: init
        run: |
          build_opts=$WXPYTHON_BUILD_ARGS
          if [ ${{ runner.os }} == 'Linux' ]; then
              short_name=linux
          elif [ ${{ matrix.os }} == macos-15-intel ]; then
              short_name=macos
              echo "CIBW_BUILD=cp$(echo ${{ matrix.python-version }} | sed 's/\.//')-macosx_$(uname -m)" >> "$GITHUB_ENV"
              echo "MACOSX_DEPLOYMENT_TARGET=14.0" >> "$GITHUB_ENV"
          elif [ ${{ matrix.os }} == macos-15 ]; then
              short_name=macos
              echo "CIBW_BUILD=cp$(echo ${{ matrix.python-version }} | sed 's/\.//')-macosx_$(uname -m)" >> "$GITHUB_ENV"
              echo "MACOSX_DEPLOYMENT_TARGET=11.0" >> "$GITHUB_ENV"
          elif [ ${{ matrix.os }} == windows-2025 ]; then
              if [ ${{ matrix.architecture }} == x64 ]; then
                  short_name=win64
              else
                  short_name=win32
              fi
          elif [ ${{ matrix.os }} == windows-11-arm ]; then
              short_name=win64
          fi
          echo "short_name=$short_name" >> "$GITHUB_OUTPUT"
          echo "canonical_id=$short_name-py${{ matrix.python-version }}-${{ matrix.architecture}}" >> "$GITHUB_OUTPUT"
          echo "build_opts=$build_opts" >> "$GITHUB_OUTPUT"

      - name: Checkout repo
        uses: actions/checkout@v6
        with:
          submodules: 'recursive'

      - name: download CI source artifact
        uses: actions/download-artifact@v8
        with:
          name: wxPython-source
          path: dist

      - name: Set up Python ${{ matrix.python-version }}-${{ matrix.architecture }}
        uses: actions/setup-python@v6
        with:
          python-version: '${{ matrix.python-version }}'
          architecture: '${{ matrix.architecture }}'
          cache: 'pip'
          allow-prereleases: true

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade -r requirements.txt

      - name: Install Ubuntu dependencies
        if: runner.os == 'Linux'
        run: |
          ./buildtools/install_depends.sh

      - name: Setup MSVC
        if: runner.os == 'Windows'
        uses: ilammy/msvc-dev-cmd@v1
        with:
          arch: '${{ matrix.architecture }}'

      - name: Build the wxPython wheel
        env:
          WXPYTHON_BUILD_ARGS: ${{ steps.init.outputs.build_opts }}
        run: |
          if [ -z "$CIBW_BUILD" ]; then
              cd dist
              pip wheel -v wxpython-${{ env.VERSION }}.tar.gz
          else
              pip install cibuildwheel
              cibuildwheel dist/wxpython-${{ env.VERSION }}.tar.gz --output-dir dist
          fi

      - name: Simple smoke test
        run: |
          cd dist
          pip install wxpython-*.whl
          python -c "import wx; print(wx); print(wx.version()); print(wx.PlatformInfo)"
          pip uninstall --yes wxPython

      - name: Save wheel as job artifact
        uses: actions/upload-artifact@v7
        # Just Windows and MacOS for now, all we care about for Linux at this
        # point is that the build was successful.
        if: runner.os != 'Linux'
        with:
          name: wxPython-wheel-${{ steps.init.outputs.canonical_id }}
          path: dist/wxpython-*.whl

  build-documentation:
    name: Build wxPython documentation
    if: github.event_name == 'push'
    runs-on: windows-2025

    steps:
      - name: Checkout repo
        uses: actions/checkout@v6
        with:
          submodules: 'recursive'
          fetch-depth: 0

      - name: Set up Python 3.13
        uses: actions/setup-python@v6
        with:
          python-version: '3.13'
          cache: 'pip'

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade -r requirements.txt
          python -m pip install --upgrade pillow numpy comtypes pywin32 cairocffi PyMuPDF

      - name: Setup MSVC
        uses: ilammy/msvc-dev-cmd@v1
        with:
          arch: 'x64'

      - name: Setup Graphviz
        uses: ts-graphviz/setup-graphviz@v2

      - name: Build documentation
        run: |
          python build.py setrev dox etg sip build_wx build_py wxlib sphinx bdist_docs docset_py

      - name: Save docs as job artifact
        uses: actions/upload-artifact@v7
        with:
          name: docs
          path: dist/wxPython-docs*.tar.gz


  publish-to-pypi:
    name: Publish Python distribution to PyPI
    if: startsWith(github.ref, 'refs/tags/')
    needs: build-wheels
    runs-on: ubuntu-24.04

    environment:
      name: pypi
      url: https://pypi.org/p/wxPython

    permissions:
      id-token: write

    steps:
    - name: Download all the dists
      uses: actions/download-artifact@v8
      with:
        pattern: wxPython-*
        path: dist/
        merge-multiple: true
    - name: Publish distribution to PyPI
      uses: pypa/gh-action-pypi-publish@release/v1


  github-release:
    name: Create GitHub Release and upload source
    needs: publish-to-pypi
    runs-on: ubuntu-24.04

    permissions:
      contents: write
      id-token: write

    steps:
    - name: Download source distribution
      uses: actions/download-artifact@v8
      with:
        name: wxPython-source
        path: dist
    - name: Create GitHub Release
      env:
        GITHUB_TOKEN: ${{ github.token }}
      run: |
        gh release create '${{ github.ref_name }}' \
          --repo '${{ github.repository }}' \
          --notes ""
    - name: Upload source distribution to GitHub Release
      env:
        GITHUB_TOKEN: ${{ github.token }}
      run: |
        gh release upload '${{ github.ref_name }}' dist/* \
          --repo '${{ github.repository }}'


  upload-demo-docs-to-extras:
    name: Upload demo/docs to extras.wxpython.org
    needs: [build-source-dist, publish-to-pypi]
    runs-on: ubuntu-24.04

    steps:
    - name: Download demo/docs
      uses: actions/download-artifact@v8
      with:
        pattern: d*
        path: dist/
        merge-multiple: true
    - name: Install SSH key
      uses: shimataro/ssh-key-action@v2
      with:
        key: ${{ secrets.RIOBU_SSH_KEY }}
        known_hosts: ${{ secrets.RIOBU_KNOWN_HOSTS }}
    - name: Make directory and SCP demo/docs
      run: |
        ssh rbot.wxpython@riobu.com mkdir -p wxpython-extras/htdocs/wxPython4/extras/${{ needs.build-source-dist.outputs.VERSION }}
        scp -p dist/* rbot.wxpython@riobu.com:wxpython-extras/htdocs/wxPython4/extras/${{ needs.build-source-dist.outputs.VERSION }}/


  upload-wheels-to-snapshot-builds:
    name: Upload wheels to snapshot-builds on wxpython.org
    if: github.event_name == 'push'
    needs: build-wheels
    runs-on: ubuntu-24.04

    steps:
    - name: Download all the dists
      uses: actions/download-artifact@v8
      with:
        path: dist/
        merge-multiple: true
    - name: Install SSH key
      uses: shimataro/ssh-key-action@v2
      with:
        key: ${{ secrets.RIOBU_SSH_KEY }}
        known_hosts: ${{ secrets.RIOBU_KNOWN_HOSTS }}
    - name: SCP wheels
      run: |
        scp -p dist/* rbot.wxpython@riobu.com:snapshot-builds/