feat!: Make the rewrite errors more useful #939

Workflow file for this run

	name: Continuous integration 🐍

	on:
	push:
	branches:
	- main
	pull_request:
	branches:
	- main
	merge_group:
	types: [checks_requested]
	workflow_dispatch: {}

	env:
	SCCACHE_GHA_ENABLED: "true"
	HUGR_BIN_DIR: ${{ github.workspace }}/target/debug
	HUGR_BIN: ${{ github.workspace }}/target/debug/hugr

	jobs:
	# Check if changes were made to the relevant files.
	# Always returns true if running on the default branch, to ensure all changes are throughly checked.
	changes:
	name: Check for changes in Python files
	runs-on: ubuntu-latest
	# Required permissions
	permissions:
	pull-requests: read
	# Set job outputs to values from filter step
	outputs:
	python: ${{ github.ref_name == github.event.repository.default_branch \|\| steps.filter.outputs.python }}
	steps:
	- uses: actions/checkout@v4
	- uses: dorny/paths-filter@v3
	id: filter
	with:
	filters: .github/change-filters.yml

	check:
	needs: changes
	if: ${{ needs.changes.outputs.python == 'true' }}

	name: check python ${{ matrix.python-version }}
	runs-on: ubuntu-latest

	strategy:
	matrix:
	python-version: ['3.10', '3.12']

	steps:
	- uses: actions/checkout@v4
	- name: Run sccache-cache
	uses: mozilla-actions/[email protected]
	- name: Install poetry
	run: pipx install poetry
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	cache: "poetry"

	- name: Install the project libraries
	run: poetry install

	- name: Type check with mypy
	run: poetry run mypy .

	- name: Check formatting with ruff
	run: poetry run ruff format --check

	- name: Lint with ruff
	run: poetry run ruff check

	build_binary:
	needs: changes
	if: ${{ needs.changes.outputs.python == 'true' }}

	name: Build HUGR binary
	runs-on: ubuntu-latest
	env:
	SCCACHE_GHA_ENABLED: "true"
	RUSTC_WRAPPER: "sccache"

	steps:
	- uses: actions/checkout@v4
	- uses: mozilla-actions/[email protected]
	- name: Install stable toolchain
	uses: dtolnay/rust-toolchain@stable
	- name: Build HUGR binary
	run: cargo build -p hugr-cli
	- name: Upload the binary to the artifacts
	uses: actions/upload-artifact@v4
	with:
	name: hugr_binary
	path: target/debug/hugr
	test:
	needs: [changes, build_binary]
	if: ${{ needs.changes.outputs.python == 'true' }}
	name: check python ${{ matrix.python-version }}
	runs-on: ubuntu-latest

	strategy:
	matrix:
	python-version: ['3.10', '3.12']
	steps:
	- uses: actions/checkout@v4
	- name: Install poetry
	run: pipx install poetry
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	cache: "poetry"

	- name: Install the project libraries
	run: poetry install
	- name: Download the hugr binary
	uses: actions/download-artifact@v4
	with:
	name: hugr_binary
	path: ${{env.HUGR_BIN_DIR}}

	- name: Run tests
	run: \|
	chmod +x $HUGR_BIN
	poetry run pytest

	# Ensure that the serialization schema is up to date
	serialization-schema:
	needs: [changes]
	if: ${{ needs.changes.outputs.python == 'true' }}
	name: Check serialization schema
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Run sccache-cache
	uses: mozilla-actions/[email protected]
	- name: Install poetry
	run: pipx install poetry
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.10"
	cache: "poetry"
	- name: Install the project libraries
	run: poetry install
	- name: Generate the updated schema
	run: \|
	poetry run python scripts/generate_schema.py specification/schema/
	- name: Check if the schema is up to date
	run: \|
	git diff --exit-code --name-only specification/schema/
	if [ $? -ne 0 ]; then
	echo "The serialization schema is not up to date"
	echo "Please run 'just update-schema' and commit the changes"
	exit 1
	fi

	# 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, test, serialization-schema]
	if: ${{ !cancelled() }}
	runs-on: ubuntu-latest
	steps:
	- 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.result == 'failure' \|\| needs.check.result == 'cancelled' \|\|
	needs.serialization-schema.result == 'failure' \|\| needs.serialization-schema.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"

	coverage:
	needs: [changes, test]
	# Run only if there are changes in the relevant files and the check job passed or was skipped
	if: always() && !failure() && !cancelled() && needs.changes.outputs.python == 'true' && github.event_name != 'merge_group'
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Run sccache-cache
	uses: mozilla-actions/[email protected]
	- name: Install poetry
	run: pipx install poetry
	- name: Set up Python 3.10
	uses: actions/setup-python@v5
	with:
	python-version: '3.10'
	cache: "poetry"

	- name: Install the project libraries
	run: poetry install
	- name: Download the hugr binary
	uses: actions/download-artifact@v4
	with:
	name: hugr_binary
	path: ${{env.HUGR_BIN_DIR}}


	- name: Run python tests with coverage instrumentation
	run: \|
	chmod +x $HUGR_BIN
	poetry run pytest --cov=./ --cov-report=xml

	- name: Upload python coverage to codecov.io
	uses: codecov/codecov-action@v4
	with:
	files: coverage.xml
	name: python
	flags: python
	token: ${{ secrets.CODECOV_TOKEN }}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: Make the rewrite errors more useful #939

Workflow file

feat!: Make the rewrite errors more useful #939

Jobs

Run details

Workflow file for this run