build_and_test.yml

name: Build and test

on:
  pull_request:
    branches:
      - main
  workflow_dispatch:

jobs:

  run-tests:
    name: Run tests
    strategy:
      matrix:
        python-version: ['3.10', '3.11', '3.12']
        os: [macos-latest, ubuntu-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Build qermit
      run: |
        pip install -e .[tests] -v
    - name: Test qermit 
      run: |
        cd tests
        pytest --cov-report term-missing:skip-covered --cov=qermit --durations=10

  build-distribution:
    name: Build distribution
    runs-on: ubuntu-latest
  
    steps:

      - name: Checkout Qermit
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.12

      - name: Install Poetry
        uses: snok/install-poetry@v1

      - name: Build Qermit
        run: poetry build

      - name: Save build
        uses: actions/upload-artifact@v4
        with:
          name: build
          path: dist

  build-docs:
    name: Test documentation build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true
      - name: Install Qermit
        run: | 
          sudo apt-get install graphviz
          pip install -e .[docs] -v
      - name: Build Docs
        run: |
          cd docs
          ./build-docs.sh
      - name: Save documentation
        uses: actions/upload-artifact@v4
        with:
          name: docs_html
          path: docs/build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs/build'

  formatting-checks:
    name: Check typing and formatting
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Build qermit
      run: |
        pip install .[tests]
        cd tests
    - name: Run mypy
      run: mypy -p qermit --warn-unused-ignores
    - name: Linting check
      run: ruff check
    - name: Format check
      run: ruff format --check