test.yml

# This GitHub action runs your tests for each commit push and/or PR. Optionally
# you can turn it on using a cron schedule for regular testing.
name: Unit Tests
on:
  pull_request:
    paths-ignore:
      - 'README.md'
      - 'docs/**'
  push:
    paths-ignore:
      - 'README.md'
      - 'docs/**'
jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    timeout-minutes: 5
    steps:
        - uses: actions/checkout@v3
        - name: Set up Python 3.8
          uses: actions/setup-python@v3
          with:
            python-version: '3.8'
        - name: Install dependencies
          run: |
            python -m pip install --upgrade pip
            pip install tox
        - name: Lint with tox
          run: tox
          env:
            TOXENV: pep8
  test:
    name: Unit Test
    runs-on: ubuntu-20.04
    timeout-minutes: 15
    strategy:
      fail-fast: false
      matrix:
        # A list of Python versions to run the tests on
        python-version: ['3.6', '3.7', '3.8', '3.9']
        include:
          - python-version: '3.6'
            TOXENV: 'py36'
          - python-version: '3.7'
            TOXENV: 'py37'
          - python-version: '3.8'
            TOXENV: 'py38'
          - python-version: '3.9'
            TOXENV: 'py39'
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v3
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install -r testing_requirements.txt
      - name: Test with tox
        run: tox
        env:
          TOXENV: ${{ matrix.TOXENV }}
  # This job will build the docs to validate
  # if Sphinx doesn't return any warnings
  sphinx:
    name: Validate Documentation
    runs-on: ubuntu-latest
    timeout-minutes: 5
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python 3.8
        uses: actions/setup-python@v3
        with:
          python-version: '3.8'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install sphinx
      - name: Build documentation via Sphinx
        run: make docs SPHINXOPTS="-W --keep-going -n"