quality_checks.yaml

# Copyright 2024 PsiQuantum, Corp.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Tests and quality checks
on: [pull_request]

jobs:
  run_tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12"]
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Setup Graphviz
        uses: ts-graphviz/setup-graphviz@v2
      - name: Install dependencies and the package
        run: |
          python -m pip install --upgrade pip poetry
          poetry install
      - name: Run unit tests
        run: poetry run pytest

  run_quality_checks:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - uses: actions/checkout@v2
      - name: Setup poetry
        uses: abatilo/actions-poetry@v2
      - name: Run quality checks
        run: |
          poetry install -E jupyter
          pip install pre-commit 
          pre-commit install
          pre-commit install --hook-type commit-msg
          pre-commit run -a
      - name: Run mypy
        run: MYPYPATH=src poetry run mypy --install-types --non-interactive src

  test_docs_are_building:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.9"
      - uses: actions/checkout@v2
      - name: Setup poetry
        uses: abatilo/actions-poetry@v2
      - name: Install package and deps
        run: |
          poetry install --with docs
      - name: Build docs
        run: poetry run mkdocs build

  test_tutorials_run:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.9"
      - uses: actions/checkout@v2
      - name: Setup poetry
        uses: abatilo/actions-poetry@v2
      - name: Setup Graphviz
        uses: ts-graphviz/setup-graphviz@v2
      - name: Install package and deps
        run: |
          poetry install -E jupyter
      - name: Convert notebooks to scripts and run them
        run: |
          poetry run jupyter nbconvert --to python docs/tutorials/*.ipynb --execute