from_commit_to_lint_test.yml

# ┌───────────────────────────────────────────────────────────────┐
# │ Contents of from_commit_to_lint_test.yml                      │
# ├───────────────────────────────────────────────────────────────┘
# │
# ├──┐From commit
# │  └── Lint and test
# │
# └───────────────────────────────────────────────────────────────

# ################################################################ From commit

name: Lint and test Python package

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

on:

  push:
    branches: [ "master" ]
    paths:
      - '**.py'

  pull_request:
    paths:
      - '**.py'
    branches: [ "master" ]

# ################################ Lint and test

jobs:
  test:
    name: Lint and test
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.12"]
    steps:

      - name: Access source code
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # 4.1.1

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # 5.0.0
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install flake8 mypy
          python -m pip install -e .

      - name: Lint with flake8
        run: |
          # stop the build if there are Python syntax errors or undefined names
          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=420 --statistics
          # type check
          mypy toc/cli.py

      - name: Test with unittest
        run: |
          # test suite
          python -m unittest