main.yml

name: CI

on:
  pull_request:
    types: [opened, reopened, ready_for_review, synchronize]
  push:
    branches: ['main']
  workflow_dispatch:

# Cancel superseded runs for the same PR. `synchronize` fires on every push to an
# open PR, so without this each push started another full wheel matrix while the
# previous one kept running to completion. A run on main is never cancelled once
# it starts, but a group holds only one running plus one pending run, so a main
# run still waiting to start can be dropped by a newer push to main.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

permissions:
  contents: read

# Reference: https://github.com/scikit-learn/scikit-learn/blob/main/.github/workflows
jobs:
  # Wheels published to PyPI are built by release.yml / pre-release.yml, which
  # each carry their own complete 20-entry matrix. This job is CI validation
  # only, so reducing it for pull requests does not change what ships.
  build_wheels:
    if: github.event.pull_request.draft == false
    runs-on: ${{ matrix.os }}
    strategy:

      # Ensure that a wheel builder finishes even if another fails
      fail-fast: false

      matrix:
        os: [windows-latest, ubuntu-latest, macos-15-intel, macos-14]

        # The only per-event switch: pull requests build 3.11, while pushes to
        # main and manual runs build every supported Python.
        python: >-
          ${{ github.event_name == 'pull_request'
          && fromJSON('[311]')
          || fromJSON('[310,311,312,313,314]') }}

        include:
          # platform_id / manylinux_image are a function of os, so these entries
          # decorate the combinations above and add no jobs of their own.
          - os: windows-latest
            platform_id: win_amd64
          - os: ubuntu-latest
            platform_id: manylinux_x86_64
            manylinux_image: manylinux_2_28
          - os: macos-15-intel
            platform_id: macosx_x86_64
          - os: macos-14
            platform_id: macosx_arm64

          # Linux is the cheapest runner, so keep every Python under test on
          # pull requests too. On main these match combinations that already
          # exist and only decorate them.
          - os: ubuntu-latest
            python: 310
            platform_id: manylinux_x86_64
            manylinux_image: manylinux_2_28
          - os: ubuntu-latest
            python: 312
            platform_id: manylinux_x86_64
            manylinux_image: manylinux_2_28
          - os: ubuntu-latest
            python: 313
            platform_id: manylinux_x86_64
            manylinux_image: manylinux_2_28
          - os: ubuntu-latest
            python: 314
            platform_id: manylinux_x86_64
            manylinux_image: manylinux_2_28

    steps:
      - name: Checkout PyQASM
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Install Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          # cibuildwheel is designed to build wheels for multiple Python versions. 
          # It does this by downloading and using the appropriate Python versions internally, 
          # independent of the Python version used to invoke cibuildwheel

          # Thus, the matrix.python is not required here, only for setting up builds
          python-version: "3.11"

      - name: Build and Test Wheels
        env: 
          # since cibuildwheel builds for all python versions >= current version, we need to 
          # restrict it to the one used in this job
          CIBW_BUILD: "cp${{ matrix.python }}-${{ matrix.platform_id }}"
          CIBW_ARCHS_LINUX: x86_64
          CIBW_MANYLINUX_X86_64_IMAGE: ${{ matrix.manylinux_image }}
          CIBW_BEFORE_BUILD: bash {project}/bin/cibw/pre_build.sh {project}
          CIBW_TEST_EXTRAS: "test,cli,pulse"
          CIBW_TEST_COMMAND: bash {project}/bin/cibw/test_wheel.sh {project}
          CIBW_BUILD_VERBOSITY: 1

        run: bash bin/cibw/build_wheels.sh

      # Used for code coverage later
      - name: Upload built package
        if: ${{ matrix.os == 'macos-14' && matrix.python == 311 }}
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: package-wheel-cp${{ matrix.python }}-${{ matrix.os }}
          path: dist/*.whl

  build_sdist:
    name: Source distribution
    if: github.event.pull_request.draft == false
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Pyqasm
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Install Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: "3.11"

      - name: Build source distribution
        run: bash bin/build_sdist.sh

      - name: Test source distribution
        run: bash bin/test_sdist.sh


  # We need a separate job for coverage as the build job is run inside a docker container. 
  # Since coverage uses files generated after running the tests, we need to run the tests on 
  # the host machine
  code-coverage:
    if: ${{ github.event.pull_request.draft == false }}
    needs: build_wheels
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          - os: macos-14
            python: 311
            platform_id: macosx_arm64
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Set up Python
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: 3.11
          cache: pip

      - name: Download built package
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
        with:
          name: package-wheel-cp${{ matrix.python }}-${{ matrix.os }}
          path: dist

      - name: Install and Test wheel with extras
        run: |
          bash bin/install_wheel_extras.sh dist --type wheel --extra test --extra cli --extra pulse
          python -m pytest --cov=pyqasm tests/ --cov-report=html --cov-report=xml --cov-report=term

      - name: Upload coverage to Codecov
        if: ${{ matrix.python == 311 }}
        uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false
          files: ./build/coverage/coverage.xml
          verbose: true