linter.yml

name: "✅ Linter"

env:
  PROJECT_FOLDER: "qgis_resource_sharing"
  PYTHON_VERSION: "3.12"

# because linter is a required check, it must be triggered on every push and not filtered on paths
on:
  push:
    branches:
      - master
    paths:
      - "**.py"
      - .github/workflows/linter.yml

  pull_request:
    branches:
      - master
    paths:
      - "**.py"
      - .github/workflows/linter.yml

jobs:
  lint-py:
    name: Python 🐍

    runs-on: ubuntu-latest

    steps:
      - name: Get source code
        uses: actions/checkout@v4

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

      - name: Install project requirements
        run: |
          python -m pip install -U pip setuptools wheel
          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