linter.yml

name: "🐍 Linter"

env:
  PROJECT_FOLDER: "qgis_resource_sharing"
  PYTHON_VERSION: 3.7

# because linter is a required check, it must be triggered on every push and not filtered on paths
on:
  push:
    branches: [master]
  #     paths:
  #       - '**.py'
  pull_request:
    branches: [master]
#     paths:
#       - '**.py'

jobs:
  flake8:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
          cache: "pip"
          cache-dependency-path: "requirements/development.txt"

      - name: Install project requirements
        run: |
          python -m pip install -U -r requirements/base.txt
          python -m pip install -U -r requirements/development.txt

      - name: Lint with flake8
        run: |
          # stop the build if there are Python syntax errors or undefined names
          flake8 ${{ env.PROJECT_FOLDER }} --count --select=E9,F63,F7,F82 --show-source --statistics
          # exit-zero treats all errors as warnings.
          flake8 ${{ env.PROJECT_FOLDER }} --count --exit-zero --statistics