cibuildwheel.yml

name: cibuildwheel

# Note: We use a dynamic matrix to build different sets of wheels under
# different conditions. On workflow_dispatch, we build the full suite of
# wheels. This takes hours, so on pull_request, we just build a representative
# sample.

# The full list of cibuildwheel's build targets can be found here:
# https://github.com/pypa/cibuildwheel/blob/v2.20.0/cibuildwheel/resources/build-platforms.toml

# Notes on build targets we (don't) support:
# - pypy: libtorrent doesn't build with pypy as of writing
# - macos_arm64: can be cross-compiled from x86_64, but not run, so can't be
#   tested. Build output indicates it isn't building correctly
# - macos_universal2: b2 / setup.py doesn't have a straightforward way to build
#   this as of writing
# - abi3: Not supported by boost-python (or pybind11) or cibuildwheel as of
#   writing

on:
  workflow_dispatch:
    inputs:
      publish:
        description: Write 'PUBLISH' to publish to pypi. BEWARE! ARTIFACTS ARE IMMUTABLE AND CANNOT BE REPLACED ONCE PUBLISHED!
      publish_test:
        description: Write 'PUBLISH_TEST' to publish to test-pypi. BEWARE! ARTIFACTS ARE IMMUTABLE AND CANNOT BE REPLACED ONCE PUBLISHED!

  pull_request:
    paths:
      - .github/workflows/cibuildwheel.yml
      - tools/cibuildwheel/**
      - pyproject.toml

concurrency:
   group: ${{ github.ref }}-${{ github.workflow }}-${{ github.event_name }}
   cancel-in-progress: true

jobs:

  configure_matrix:
    runs-on: ubuntu-latest
    env:
      # github actions syntax doesn't allow us to have yaml structures as
      # an input to a job. These environment variables are literal json strings
      MATRIX_PULL_REQUEST: |
        {
          "include": [
            {"os": "ubuntu-24.04", "CIBW_BUILD": "cp311-manylinux_x86_64"},
            {"os": "ubuntu-24.04", "CIBW_BUILD": "cp311-musllinux_x86_64"},
            {"os": "macos-12", "CIBW_BUILD": "cp311-macosx_x86_64", "MACOSX_DEPLOYMENT_TARGET": "12"},
            {"os": "macos-13", "CIBW_BUILD": "cp311-macosx_x86_64", "MACOSX_DEPLOYMENT_TARGET": "13"},
            {"os": "macos-14", "CIBW_BUILD": "cp311-macosx_arm64", "MACOSX_DEPLOYMENT_TARGET": "14"},
            {"os": "windows-latest", "CIBW_BUILD": "cp311-win_amd64"}
          ]
        }
      MATRIX_WORKFLOW_DISPATCH: |
        {
          "include": [
            {"os": "ubuntu-latest", "CIBW_BUILD": "cp*-manylinux_x86_64"},
            {"os": "ubuntu-latest", "CIBW_BUILD": "cp*-manylinux_aarch64"},
            {"os": "ubuntu-latest", "CIBW_BUILD": "cp*-musllinux_x86_64"},
            {"os": "ubuntu-latest", "CIBW_BUILD": "cp*-musllinux_aarch64"},
            {"os": "macos-12", "CIBW_BUILD": "cp*-macosx_x86_64", "MACOSX_DEPLOYMENT_TARGET": "12"},
            {"os": "macos-13", "CIBW_BUILD": "cp*-macosx_x86_64", "MACOSX_DEPLOYMENT_TARGET": "13"},
            {"os": "macos-14", "CIBW_BUILD": "cp*-macosx_arm64", "MACOSX_DEPLOYMENT_TARGET": "14"},
            {"os": "windows-latest", "CIBW_BUILD": "cp*-win32"},
            {"os": "windows-latest", "CIBW_BUILD": "cp*-win_amd64"}
          ]
        }

    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}

    steps:
    - id: set-matrix
      run: |
        if [ $GITHUB_EVENT_NAME == "pull_request" ]; then
          echo "matrix=$(echo $MATRIX_PULL_REQUEST | jq -c)" >> "$GITHUB_OUTPUT"
        else
          echo "matrix=$(echo $MATRIX_WORKFLOW_DISPATCH | jq -c)" >> "$GITHUB_OUTPUT"
        fi

  build_wheels:
    needs: configure_matrix
    runs-on: ${{ matrix.os }}

    strategy:
      fail-fast: false
      matrix: ${{ fromJSON(needs.configure_matrix.outputs.matrix) }}

    env:
      CIBW_BUILD_VERBOSITY: 1
      CIBW_BUILD: ${{ matrix.CIBW_BUILD }}
      CIBW_MANYLINUX_*_IMAGE: "manylinux_2_28"
      CIBW_MUSLLINUX_*_IMAGE: "musllinux_1_2"
      MACOSX_DEPLOYMENT_TARGET: ${{ matrix.MACOSX_DEPLOYMENT_TARGET }}
      CIBW_SKIP: pp*
      CIBW_TEST_SKIP: "*-win32"

    steps:
    - uses: actions/checkout@v4
      with:
        submodules: true
        fetch-depth: 1
        filter: tree:0

    - uses: actions/cache@v4
      id: cache-wheel
      with:
        path: wheelhouse
        key: wheel-${{ matrix.os }}-${{ matrix.CIBW_BUILD }}-${{ github.sha }}

    - uses: docker/setup-qemu-action@v3
      if: steps.cache-wheel.outputs.cache-hit != 'true' && runner.os == 'Linux'

    - uses: pypa/cibuildwheel@v2.20.0
      if: steps.cache-wheel.outputs.cache-hit != 'true'

    - uses: actions/upload-artifact@v3
      with:
        path: wheelhouse/*.whl
        name: wheels

  upload_pypi:
    needs: build_wheels
    runs-on: ubuntu-latest
    if: needs.build_wheels.result == 'success' && github.event.inputs.publish == 'PUBLISH'

    steps:
    - uses: actions/download-artifact@v3
      with:
        name: wheels
        path: wheelhouse

    - uses: pypa/gh-action-pypi-publish@release/v1
      with:
        password: ${{ secrets.PYPI_API_TOKEN }}
        packages-dir: wheelhouse
        skip-existing: true

  upload_pypi_test:
    needs: build_wheels
    runs-on: ubuntu-latest
    if: needs.build_wheels.result == 'success' && github.event.inputs.publish_test == 'PUBLISH_TEST'

    steps:
    - uses: actions/download-artifact@v3
      with:
        name: wheels
        path: wheelhouse

    - uses: pypa/gh-action-pypi-publish@release/v1
      with:
        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
        packages-dir: wheelhouse
        skip-existing: true
        repository_url: https://test.pypi.org/legacy/