tests.yaml

name: Tests

on:
  push:
    branches: [ master ]
    tags: [ '[0-9]+.[0-9]+.[0-9]+*' ]
  pull_request:
    branches: [ master ]

jobs:

  linters:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v4
      with:
        python-version: '3.8'

    - name: Install pre-commit
      run: |
        pip install pre-commit

    - name: run linters
      # pre-commit also runs in pre-commit.ci, but let's have it here too
      # to block `pypi-publish` job from triggering if pre-commit fails
      run: |
        pre-commit run -a

  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        python-version: ['pypy3.10', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13-dev']
        os: [ubuntu-latest, macos-latest, windows-latest]
    continue-on-error: ${{ matrix.python-version == '3.13-dev' }}

    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 package
      run: |
        pip install .

    - name: Test with unittest
      run: |
        python -m unittest

  coverage:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v4
      with:
        python-version: '3.x'
    - name: Install package and coverage deps
      run: |
        pip install . coverage
    - name: Measure coverage
      run: |
        # Coverage should be 100% without external tests
        rm -rf tests/data/valid/_external/
        rm -rf tests/data/invalid/_external/
        coverage run -m unittest
        coverage report --fail-under=100
    - name: Report coverage
      uses: codecov/codecov-action@v3

  allgood:
    runs-on: ubuntu-latest
    needs:
    - tests
    - coverage
    - linters
    steps:
    - run: echo "Great success!"

  pypi-publish:
    # Only publish if all other jobs succeed
    needs: [ allgood ]
    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v4
      with:
        python-version: '3.x'
    - name: Install build and publish tools
      run: |
        pip install build twine
    - name: Build and check
      run: |
        rm -rf dist/ && python -m build
        twine check --strict dist/*
    - name: Publish
      run: |
        twine upload dist/*
      env:
        TWINE_USERNAME: __token__
        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}