ci.yml

---
name: ranzen CI

on:
  pull_request:
    branches:
    - main

jobs:
  format_with_black:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.11
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"
    - name: Install poetry
      run: pipx install poetry
    - name: Install dependencies
      run: |
        poetry env use 3.11
        poetry install --no-interaction --no-root --only lint
    - name: Format with ruff
      run: |
        poetry run ruff format --diff .

  lint_with_ruff:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.11
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"
    - name: Install poetry
      run: pipx install poetry
    - name: Install dependencies
      run: |
        poetry env use 3.11
        poetry install --no-interaction --no-root --only lint
    - name: Lint with ruff
      run: |
        poetry run ruff check --output-format=github .

  check_docstrings:

    runs-on: ubuntu-latest

    steps:
      # ----------------------------------------------
      #  ----  check-out repo and set-up python ----
      # ----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@v3
      # ----------------------------------------------
      #  -----  install & configure poetry  -----
      # ----------------------------------------------
      - name: Install poetry
        run: pipx install poetry
      - name: Set up Python 3.10
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"
          cache: 'poetry'

      # ----------------------------------------------
      # install dependencies if cache does not exist
      # ----------------------------------------------
      - name: Install dependencies
        run: |
          poetry env use 3.10
          poetry install --no-interaction --no-root -E all --with torchcpu --without lint --with docs
      - name: Check docstrings with pydoclint
        run: |
          poetry run pydoclint ranzen
      - name: Build with sphinx
        run: |
          poetry run sphinx-build -W -b html ./docs ./docs/_build

  run_tests_and_type_checking:
    needs: [format_with_black, lint_with_ruff, check_docstrings]
    runs-on: ubuntu-latest

    steps:
      # ----------------------------------------------
      #  ----  check-out repo and set-up python ----
      # ----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@v3
      # ----------------------------------------------
      #  -----  install & configure poetry  -----
      # ----------------------------------------------
      - name: Install poetry
        run: pipx install poetry
      - name: Set up Python 3.10
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"
          cache: 'poetry'

      # ----------------------------------------------
      # install dependencies if cache does not exist
      # ----------------------------------------------
      - name: Install dependencies
        run: |
          poetry env use 3.10
          poetry install --no-interaction --no-root -E all --with torchcpu --without lint

      # ----------------------------------------------
      #  -----         Run type checking        -----
      # ----------------------------------------------
      - name: Set python path for all subsequent actions
        run: echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
      - name: Get Pyright Version
        id: pyright-version
        run: |
          PYRIGHT_VERSION=$(jq -r '.devDependencies.pyright' < package.json)
          echo "found pyright version: $PYRIGHT_VERSION"
          echo "version=$PYRIGHT_VERSION" >> $GITHUB_OUTPUT
        working-directory: .github
        shell: bash
      - uses: jakebailey/pyright-action@v2
        with:
          # don't show warnings
          level: error
          # use the version we extracted above
          version: ${{ steps.pyright-version.outputs.version }}

      # ----------------------------------------------
      #  -----           Run Tests            -----
      # ----------------------------------------------
      - name: Test with pytest
        run: |
          poetry run python -m pytest -vv tests/