Continuous integration #4071
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Continuous integration | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| merge_group: | |
| types: [checks_requested] | |
| workflow_dispatch: {} | |
| env: | |
| CARGO_TERM_COLOR: always | |
| CARGO_INCREMENTAL: 0 | |
| RUSTFLAGS: "--cfg=ci_run" | |
| MIRIFLAGS: '-Zmiri-permissive-provenance' # Required due to warnings in bitvec 1.0.1 | |
| CI: true # insta snapshots behave differently on ci | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| # Pinned version for the uv package manager | |
| UV_VERSION: "0.4.20" | |
| UV_FROZEN: 1 | |
| # The highest and lowest supported Python versions, used for testing | |
| PYTHON_HIGHEST: "3.13" | |
| PYTHON_LOWEST: "3.10" | |
| # different strings for install action and feature name | |
| # adapted from https://github.com/TheDan64/inkwell/blob/master/.github/workflows/test.yml | |
| LLVM_VERSION: "14.0" | |
| LLVM_FEATURE_NAME: "14-0" | |
| TKET_C_API_PATH: "${{ github.workspace }}/tket-c-api" | |
| LD_LIBRARY_PATH: ${{ github.workspace }}/tket-c-api/lib | |
| jobs: | |
| # Check if changes were made to the relevant files. | |
| # Always returns true if running on the default branch, to ensure all changes are thoroughly checked. | |
| changes: | |
| name: Check for changes | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: read | |
| outputs: | |
| rust: ${{ steps.filter.outputs.rust }} | |
| python: ${{ steps.filter.outputs.python }} | |
| extensions: ${{ steps.filter.outputs.llvm }} | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: ./.github/actions/check-changes | |
| id: filter | |
| check-rs: | |
| name: Check Rust code 🦀 | |
| needs: [changes] | |
| if: ${{ needs.changes.outputs.rust == 'true' }} | |
| runs-on: ubuntu-latest | |
| env: | |
| # Fail on rust compiler warnings. | |
| RUSTFLAGS: -D warnings | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt, clippy | |
| # This step is not required, but speeds up the build by caching the tket-c-api library | |
| # The alternative is to install conan and remove the `TKET_C_API_PATH` env var | |
| - name: Install tket-c-api library | |
| uses: ./.github/actions/tket-c-api | |
| with: | |
| install-path: ${{ env.TKET_C_API_PATH }} | |
| - name: Check formatting | |
| run: cargo fmt -- --check | |
| - name: Install LLVM and Clang | |
| uses: KyleMayes/install-llvm-action@v2 | |
| with: | |
| version: ${{ env.LLVM_VERSION }} | |
| - name: Run clippy | |
| run: cargo clippy --all-targets --all-features --workspace -- -D warnings | |
| - name: Build docs | |
| run: cargo doc --no-deps --all-features --workspace | |
| env: | |
| RUSTDOCFLAGS: "-Dwarnings" | |
| check-py: | |
| name: Check Python code 🐍 | |
| needs: changes | |
| if: ${{ needs.changes.outputs.python == 'true' }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| version: ${{ env.UV_VERSION }} | |
| enable-cache: true | |
| - name: Install Python ${{ env.PYTHON_HIGHEST }} | |
| run: uv python install ${{ env.PYTHON_HIGHEST }} | |
| - name: Setup dependencies | |
| run: uv sync --python ${{ env.PYTHON_HIGHEST }} | |
| - name: Type check with mypy | |
| run: uv run mypy . | |
| - name: Check formatting with ruff | |
| run: uv run ruff format --check | |
| - name: Lint with ruff | |
| run: uv run ruff check | |
| benches: | |
| name: Continuous benchmarking 🏋️ | |
| needs: changes | |
| if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }} | |
| runs-on: ubuntu-latest | |
| permissions: | |
| checks: write | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| - uses: cargo-bins/cargo-binstall@main | |
| - name: Install cargo-codspeed | |
| run: cargo binstall cargo-codspeed --force | |
| - name: Override criterion with the CodSpeed harness | |
| run: cargo add --dev codspeed-criterion-compat --rename criterion --package tket | |
| - name: Build benchmarks | |
| run: cargo codspeed build --profile bench --features portmatching,binary-eccs,rewrite-tracing | |
| - name: Run benchmarks | |
| uses: CodSpeedHQ/action@v3 | |
| with: | |
| token: ${{ secrets.CODSPEED_TOKEN }} | |
| run: "cargo codspeed run" | |
| # Run tests on Rust stable | |
| tests-rs-stable-no-features: | |
| needs: changes | |
| if: ${{ needs.changes.outputs.rust == 'true' }} | |
| runs-on: ubuntu-latest | |
| name: tests (Rust stable, no features) | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - id: toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: 'stable' | |
| - name: Configure default rust toolchain | |
| run: rustup override set ${{steps.toolchain.outputs.name}} | |
| - name: Build with no features | |
| run: cargo test --verbose -p tket -p tket-py -p tket-qsystem --no-default-features --no-run | |
| - name: Tests with no features | |
| run: cargo test --verbose -p tket -p tket-py -p tket-qsystem --no-default-features | |
| # Run tests on Rust stable | |
| tests-rs-stable-all-features: | |
| needs: [changes] | |
| if: ${{ needs.changes.outputs.rust == 'true' }} | |
| runs-on: ubuntu-latest | |
| name: tests (Rust stable, all features) | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - id: toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: "stable" | |
| - name: Configure default rust toolchain | |
| run: rustup override set ${{steps.toolchain.outputs.name}} | |
| - name: Install LLVM and Clang | |
| uses: KyleMayes/install-llvm-action@v2 | |
| with: | |
| version: ${{ env.LLVM_VERSION }} | |
| # This step is not required, but speeds up the build by caching the tket-c-api library | |
| # The alternative is to install conan and remove the `TKET_C_API_PATH` env var | |
| - name: Install tket-c-api library | |
| uses: ./.github/actions/tket-c-api | |
| with: | |
| install-path: ${{ env.TKET_C_API_PATH }} | |
| - name: Build with all features | |
| run: cargo test --verbose --workspace --all-features --no-run | |
| - name: Tests with all features | |
| run: cargo test --verbose --workspace --all-features | |
| # Run tests on other toolchains | |
| tests-rs-other: | |
| needs: [changes] | |
| if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| # Stable is covered by `tests-stable-no-features` and `tests-stable-all-features` | |
| # Nightly is covered by `tests-nightly-coverage` | |
| rust: ['1.85', beta] | |
| name: tests (Rust ${{ matrix.rust }}) | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - id: toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| - name: Install LLVM and Clang | |
| uses: KyleMayes/install-llvm-action@v2 | |
| with: | |
| version: ${{ env.LLVM_VERSION }} | |
| # This step is not required, but speeds up the build by caching the tket-c-api library | |
| # The alternative is to install conan and remove the `TKET_C_API_PATH` env var | |
| - name: Install tket-c-api library | |
| uses: ./.github/actions/tket-c-api | |
| with: | |
| install-path: ${{ env.TKET_C_API_PATH }} | |
| - name: Configure default rust toolchain | |
| run: rustup override set ${{steps.toolchain.outputs.name}} | |
| - name: Build with no features | |
| run: cargo test --verbose --workspace --no-default-features --no-run | |
| - name: Tests with no features | |
| run: cargo test --verbose --workspace --no-default-features | |
| - name: Build with all features | |
| run: cargo test --verbose --workspace --all-features --no-run | |
| - name: Tests with all features | |
| run: cargo test --verbose --workspace --all-features | |
| tests-nightly-coverage: | |
| needs: [changes] | |
| # Run only if there are changes in the relevant files | |
| if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }} | |
| runs-on: ubuntu-latest | |
| name: tests (Rust nightly, coverage) | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - uses: dtolnay/rust-toolchain@master | |
| with: | |
| # Nightly is required to count doctests coverage | |
| # TODO: Pinned due to <https://github.com/CQCL/hugr/issues/2227 | |
| toolchain: "nightly-2025-05-14" | |
| components: llvm-tools-preview | |
| - name: Install LLVM and Clang | |
| uses: KyleMayes/install-llvm-action@v2 | |
| with: | |
| version: ${{ env.LLVM_VERSION }} | |
| # This step is not required, but speeds up the build by caching the tket-c-api library | |
| # The alternative is to install conan and remove the `TKET_C_API_PATH` env var | |
| - name: Install tket-c-api library | |
| uses: ./.github/actions/tket-c-api | |
| with: | |
| install-path: ${{ env.TKET_C_API_PATH }} | |
| - name: Install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: Run tests with coverage instrumentation | |
| run: | | |
| cargo llvm-cov clean --workspace | |
| cargo llvm-cov --no-report --workspace --no-default-features --doctests | |
| cargo llvm-cov --no-report --workspace --all-features --doctests | |
| - name: Generate coverage report | |
| run: cargo llvm-cov --all-features report --codecov --output-path coverage.json | |
| - name: Upload coverage to codecov.io | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| files: coverage.json | |
| name: rust | |
| flags: rust | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| tests-py: | |
| needs: changes | |
| if: ${{ needs.changes.outputs.python == 'true' }} | |
| runs-on: ubuntu-latest | |
| name: tests (Python, coverage) | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v6 | |
| with: | |
| version: ${{ env.UV_VERSION }} | |
| enable-cache: true | |
| - name: Install Python ${{ env.PYTHON_LOWEST }} | |
| run: uv python install ${{ env.PYTHON_LOWEST }} | |
| - name: Setup dependencies | |
| run: uv sync --python ${{ env.PYTHON_LOWEST }} | |
| - name: Run python tests with coverage instrumentation | |
| run: uv run pytest --cov=./ --cov-report=xml | |
| - name: Upload python coverage to codecov.io | |
| if: github.event_name != 'merge_group' | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| files: ./coverage.xml | |
| # Ensures we only upload this file | |
| disable_search: true | |
| name: python | |
| flags: python | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| # Ensure that serialized extensions match rust implementation | |
| tket-extensions: | |
| needs: [changes, tests-rs-stable-all-features] | |
| if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }} | |
| name: Check standard extensions | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: mozilla-actions/sccache-action@v0.0.9 | |
| - name: Install stable toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| - uses: extractions/setup-just@v3 | |
| - name: Generate the updated definitions | |
| run: just gen-extensions | |
| - name: Check if the declarations are up to date | |
| run: | | |
| git diff --exit-code --name-only tket-exts/src/tket_exts/data | |
| if [ $? -ne 0 ]; then | |
| echo "The serialized standard extensions are not up to date" | |
| echo "Please run 'just gen-extensions' and commit the changes. | |
| Bump the version of tket-exts according to semver. | |
| " | |
| exit 1 | |
| fi | |
| extension-versions: | |
| runs-on: ubuntu-latest | |
| needs: [changes] | |
| if: ${{ needs.changes.outputs.extensions == 'true' }} | |
| name: Check extension versions | |
| steps: | |
| - uses: actions/checkout@v5 | |
| with: | |
| fetch-depth: 0 # Need full history to compare with main | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Check if extension versions are updated | |
| run: | | |
| # Check against latest tag on the target branch | |
| # When not on a pull request, base_ref should be empty so we default to HEAD | |
| if [ -z "$TARGET_REF" ]; then | |
| BASE_SHA="HEAD~1" | |
| else | |
| BASE_SHA=$(git rev-parse origin/$TARGET_REF) | |
| fi | |
| echo "Comparing to ref: $BASE_SHA" | |
| python ./scripts/check_extension_versions.py $BASE_SHA | |
| env: | |
| TARGET_REF: ${{ github.base_ref }} | |
| # This is a meta job to mark successful completion of the required checks, | |
| # even if they are skipped due to no changes in the relevant files. | |
| required-checks: | |
| name: Required checks 🦀+🐍 | |
| needs: [changes, check-rs, check-py, tests-rs-stable-no-features, tests-rs-stable-all-features, tests-py, tket-extensions, extension-versions] | |
| if: ${{ !cancelled() }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Debug changes step output | |
| run: | | |
| echo "Rust: ${{ needs.changes.outputs.rust }}" | |
| echo "Python: ${{ needs.changes.outputs.python }}" | |
| - name: Fail if required checks failed | |
| # This condition should simply be `if: failure() || cancelled()`, | |
| # but there seems to be a bug in the github workflow runner. | |
| # | |
| # See https://github.com/orgs/community/discussions/80788 | |
| if: | | |
| needs.changes.result == 'failure' || needs.changes.result == 'cancelled' || | |
| needs.check-rs.result == 'failure' || needs.check-rs.result == 'cancelled' || | |
| needs.check-py.result == 'failure' || needs.check-py.result == 'cancelled' || | |
| needs.tests-rs-stable-no-features.result == 'failure' || needs.tests-rs-stable-no-features.result == 'cancelled' || | |
| needs.tests-rs-stable-all-features.result == 'failure' || needs.tests-rs-stable-all-features.result == 'cancelled' || | |
| needs.tests-py.result == 'failure' || needs.tests-py.result == 'cancelled' | |
| run: | | |
| echo "Required checks failed" | |
| echo "Please check the logs for more information" | |
| exit 1 | |
| - name: Pass if required checks passed | |
| run: | | |
| echo "All required checks passed" |