pr-check.yml

---
# This workflow will install Python dependencies, run tests and lint with a
# variety of Python versions. For more information see:
# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Check PR

'on':
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

permissions: {}

jobs:
  unittest:
    name: python${{ matrix.python-version }}
    runs-on: ubuntu-20.04

    strategy:
      matrix:
        python-version:
          - '3.6.8'   # slc7, slc8 and cs8 containers
          - '3.7'
          - '3.8'
          - '3.9'
          - '3.10'
          - '3.11'

    steps:
      - uses: actions/checkout@v3

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

      - name: Install test dependencies
        run: |
          sudo apt update -y
          sudo apt install -y curl libcurl4-gnutls-dev build-essential gfortran libmysqlclient-dev xorg-dev libglu1-mesa-dev libfftw3-dev libxml2-dev git unzip autoconf automake autopoint texinfo gettext libtool libtool-bin pkg-config bison flex libperl-dev libbz2-dev swig liblzma-dev libnanomsg-dev rsync lsb-release unzip environment-modules libglfw3-dev libtbb-dev python3-venv libncurses-dev environment-modules libxml2-dev libxslt1-dev
          python -m pip install --upgrade tox tox-gh-actions coverage

      - name: Run tests
        run: tox

      - name: Convert coverage information
        if: ${{ always() && github.event.repository.owner.login == 'alisw' }}
        run: |
          coverage combine .tox/coverage.*
          # Codecov only understands XML, JSON and LCOV files.
          # Apparently, patching os.readlink in unit tests interferes with
          # finding some source files, but our source shouldn't be affected, so
          # ignore these errors.
          coverage json --ignore-errors -o coverage.json

      - name: Upload coverage information
        if: ${{ always() && github.event.repository.owner.login == 'alisw' }}
        uses: codecov/codecov-action@v3
        with:
          files: coverage.json

  lint:
    name: lint
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.x

      - name: Install dependencies
        run: python -m pip install --upgrade tox tox-gh-actions

      - name: Run linters
        run: tox -e lint

  documentation:
    name: documentation
    runs-on: ubuntu-latest
    container:
      image: jekyll/jekyll

    steps:
      - uses: actions/checkout@v3

      - name: Test documentation
        run: |
          chmod -R a+rwX .
          jekyll build -s docs -d _site --baseurl .
          script/custom_htmlproofer.rb