python-publish.yml

#.github/workflows/python-publish.yml

name: Build and Publish Python Package

# Workflow Triggers:
# 1. On push to any branch (e.g., main, feature/xyz): triggers build.
# 2. On push of tags starting with 'v' (e.g., v1.2.3): triggers build and publish.
# 3. On pull request to main branch: triggers build.
# 4. Manual trigger via GitHub Actions UI.
on:
  push:
    tags:
      - 'v*'
  workflow_dispatch:

jobs:
  # --- Job 1: Build Cross-Platform Wheels ---
  # This job runs on all triggers and builds binary wheels for multiple platforms.
  build_wheels:
    name: Build wheels on ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: ubuntu-latest
            arch: x86_64
            name: "Linux x86_64"
          - os: ubuntu-24.04-arm   # ARM64 Linux
            arch: aarch64
            name: "Linux ARM64"
          - os: macos-15-intel    # Intel Mac (x86_64)
            arch: "x86_64"  # Build only x86_64
            name: "macOS Intel"
          - os: macos-14    # M1/M2 Mac (ARM64)
            arch: "arm64"   # Build only arm64
            name: "macOS Silicon"

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

      - name: Export Compiler Paths (macOS)
        if: runner.os == 'macOS'
        run: |
          GMP=$(brew --prefix gmp)
          MPFR=$(brew --prefix mpfr)
          
          if [[ "${{ matrix.os }}" == "macos-14" ]]; then
            echo "CIBW_ENVIRONMENT_MACOS=MACOSX_DEPLOYMENT_TARGET=14.0 CFLAGS=\"-I$GMP/include -I$MPFR/include\" LDFLAGS=\"-L$GMP/lib -Wl,-rpath,$GMP/lib -L$MPFR/lib -Wl,-rpath,$MPFR/lib\" CMAKE_PREFIX_PATH=\"$GMP;$MPFR\"" >> $GITHUB_ENV
          else
            echo "CIBW_ENVIRONMENT_MACOS=MACOSX_DEPLOYMENT_TARGET=15.0 CFLAGS=\"-I$GMP/include -I$MPFR/include\" LDFLAGS=\"-L$GMP/lib -Wl,-rpath,$GMP/lib -L$MPFR/lib -Wl,-rpath,$MPFR/lib\" CMAKE_PREFIX_PATH=\"$GMP;$MPFR\"" >> $GITHUB_ENV
          fi          

      - name: Build wheels
        uses: pypa/cibuildwheel@v3.3.1
        env:
          CIBW_ARCHS: ${{ matrix.arch }}

          CIBW_TEST_REQUIRES: pytest
          CIBW_BEFORE_TEST: "pip install \".[dev]\""
          CIBW_TEST_COMMAND: pytest -n auto -k "not (Feynman or MQT)" {project}/test

      - name: Upload wheel artifacts (for all builds - general purpose)
        uses: actions/upload-artifact@v4
        with:
          name: all-builds-dist-wheels-${{ matrix.os }}
          path: ./wheelhouse/*.whl

      - name: Upload wheel artifacts (for PyPI release - only on tags)
        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
        uses: actions/upload-artifact@v4
        with:
          name: pypi-release-wheels-${{ matrix.os }}
          path: ./wheelhouse/*.whl
  # --- Job 2: Build Source Distribution (Sdist) ---
  # This job runs on all triggers and builds the source distribution.
  build_sdist:
    name: Build source distribution
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: 'recursive'
          fetch-depth: 0

      - name: Install build tool
        run: pip install build maturin

      - name: Clean up existing dist directory
        run: rm -rf dist/

      - name: Build sdist with build module
        run: python -m build --sdist

      - name: Upload sdist artifact (for all builds - general purpose)
        uses: actions/upload-artifact@v4
        with:
          name: all-builds-dist-sdist
          path: dist/*.tar.gz

      - name: Upload sdist artifact (for PyPI release - only on tags)
        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
        uses: actions/upload-artifact@v4
        with:
          name: pypi-release-sdist
          path: dist/*.tar.gz


  # --- Job 3: Publish to PyPI and Create GitHub Release ---
  # This job runs only when a 'v*' tag is pushed.
  # It publishes all built artifacts to PyPI and creates a GitHub Release.
  publish:
    name: Publish to PyPI and Create Release
    # 'needs' ensures this job runs only after all build jobs succeed.
    needs: [build_wheels, build_sdist]
    # Condition: Only run when a 'v*' tag is pushed.
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
    runs-on: ubuntu-latest

    # Uses PyPI Trusted Publishing (OIDC) for secure publishing.
    permissions:
      # id-token: write is required for OIDC Trusted Publishing.
      id-token: write
      # contents: write is required to create a GitHub Release.
      contents: write

    steps:
      - name: Download all release artifacts
        uses: actions/download-artifact@v4
        with:
          pattern: pypi-release-*
          path: dist
          merge-multiple: true
      - name: List files in dist directory (for debugging)
        run: ls -R dist

      - name: Publish package to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1

      - name: Create GitHub Release
        uses: softprops/action-gh-release@v2
        with:
          tag_name: ${{ github.ref_name }}
          name: Release ${{ github.ref_name }}
          body: |
            ## 🚀 Release Notes
            * **📦 Version:** `${{ github.ref_name }}`
            * **🔗 PyPI Link:** https://pypi.org/project/QuPRS/${{ github.ref_name }}
            * 🛠️ This release was automatically generated by GitHub Actions.
          files: dist/*