unit_tests.yml

# GitHub Actions workflow for testing and continuous integration.
#
# This file performs testing using tox and tox.ini to define and configure the test environments.

name: unit_tests

on:
  push:
    branches:
    - main  # GitHub now defaults to 'main' as the name of the primary branch. Change this as needed.
  #  tags: # run CI if specific tags are pushed
  pull_request:
    # branches: # only build on PRs against 'main' if you need to further limit when CI is run.
    #    - main

jobs:
  # Github Actions supports ubuntu, windows, and macos virtual environments:
  # https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners
  ci_tests:
    name: ${{ matrix.name }}
    runs-on: ${{ matrix.os }}
    timeout-minutes: 60
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: Code style checks
            os: ubuntu-latest
            python: '3.9'
            toxenv: codestyle

          - name: Python 3.9 with minimal dependencies
            os: ubuntu-latest
            python: '3.9'
            toxenv: py39-test

          - name: Python 3.10 with minimal dependencies
            os: ubuntu-latest
            python: '3.10'
            toxenv: py310-test

          - name: Python 3.9 with all optional dependencies and coverage checking
            os: ubuntu-latest
            python: '3.9'
            toxenv: py39-test-alldeps-cov

          - name: OS X - Python 3.9 with all optional dependencies
            os: macos-latest
            python: '3.9'
            toxenv: py39-test-alldeps

          - name: Windows - Python 3.9 with all optional dependencies
            os: windows-latest
            python: '3.9'
            toxenv: py39-test-alldeps

          - name: Test building of Sphinx docs
            os: ubuntu-latest
            python: '3.9'
            toxenv: build_docs

    steps:
    - name: Install Pandoc
      if: ${{ matrix.toxenv == 'build_docs' }}
      run: |
        sudo apt-get install -y pandoc
    - name: Checkout code
      uses: actions/checkout@v2
      with:
        fetch-depth: 0
    - name: Set up python ${{ matrix.python }} on ${{ matrix.os }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python }}
    - name: Install base dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install tox codecov
    - name: Test with tox
      run: |
        tox -e ${{ matrix.toxenv }}