pylint.yml

# https://github.com/marketplace/actions/github-action-for-pylint
# https://www.henryschmale.org/2021/01/21/pylint-github-actions.html
# Note: pylint can be very strict, so args may need to be tweaked.
name: Pylint

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.11"]
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      # https://github.com/marketplace/actions/python-poetry-action#workflow-example-cache-the-virtual-environment
      - name: Install poetry
        uses: abatilo/actions-poetry@v2
      # - name: Setup a local virtual environment (if no poetry.toml file)
      #   run: |
      #     poetry config virtualenvs.create true --local
      #     poetry config virtualenvs.in-project true --local
      # - uses: actions/cache@v3
      #   name: Define a cache for the virtual environment based on the dependencies lock file
      #   with:
      #     path: ./.venv
      #     key: venv-${{ hashFiles('poetry.lock') }}
      - name: Install the project dependencies
        run: poetry install
      - name: Run pylint
        run: |
          poetry add pylint
          poetry run pylint --fail-under=9 $(git ls-files '*.py')
          # 'cyclic imports' seems to be a false negative