lint-test-cover-docs.yml

name: lint-test-cover-docs
on:
  push
jobs:
  lint_test_cover_docs:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.7', '3.8', '3.9', '3.10']
    name: "Python ${{ matrix.python-version }}"
    steps:
      - uses: actions/checkout@v2
      - name: Install Python.
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
          architecture: x64

      - name: Install pipenv
        run: |
          python -m pip install --upgrade pip setuptools wheel
          pip install pipenv

      - name: Cache pipenv
        id: cache-pipenv
        uses: actions/cache@v2
        with:
          path: ~/.local/share/virtualenvs
          key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}

      - name: Lint and test module.
        run: |
          pipenv install --dev
          pipenv run flake8 # Check against linting rules.
          pipenv run pytest --cov=sfu --cov-report term-missing # Test using pytest.

      - name: Publish coverage results.
        run: |
          pipenv install coveralls
          pipenv run coveralls --service=github # Submit to coveralls.
        if: matrix.python-version == '3.8'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Test auto-generation of documentation.
        run: |
          pip install -U -r docs/requirements.txt
          # Get sfu installed outside of virtualenv so it can be used to generate docs. These run without pipenv.
          pip install -e .
          cd docs && sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html && cd ..