python-tests.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Tests

on:
  push:
    paths-ignore:
      - 'examples/**'
      - 'docs/**'
      - 'README.md'
      - 'LICENSE'
      - '.gitignore'

  pull_request:
    branches:
      - main

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install ".[tests]"
        # ^ install local package with extra test dependencies

    - name: Lint with flake8
      continue-on-error: true
      run: |
        flake8 folktexts tests --count --statistics

    - name: Test with pytest
      run: |
        coverage run -m pytest tests && coverage report -m
        # TODO: $ coverage run -m pytest tests && coverage report -m --fail-under=75