lint.yml

name: Lint

on:
  push:
    branches:
      - "main"
    paths:
      - '**.py' # Run if pushed commits include a change to a Python (.py) file.
      - '.github/workflows/lint.yml' # Run if pushed commits include a change to a github actions workflow file.
      - 'requirements.txt' # Run if pushed commits include a change to the Python requirements.txt file.
      - '.pyprogject.toml' # Run if project configuration file changes.
  pull_request:
    branches:
      - "main"
    paths:
      - '**.py' # Run if pushed commits include a change to a Python (.py) file.
      - '.github/workflows/lint.yml' # Run if pushed commits include a change to a github actions workflow file.
      - 'requirements.txt' # Run if pushed commits include a change to the Python requirements.txt file.
      - '.pyprogject.toml' # Run if project configuration file changes.
  workflow_dispatch:

jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
        python-version:
          - "3.12"

    runs-on: ${{ matrix.os }}

    permissions:
      security-events: write
      actions: read
      contents: read

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip

      - name: Install uv and create venv
        run: |
          pip install -U pip uv
          uv venv

      - name: Enable venv
        run: |
          source .venv/bin/activate
          echo $PATH >> $GITHUB_PATH

      - name: Install dependencies
        run: |
          if [ -f requirements.txt ]; then uv pip install -r requirements.txt; fi

      - name: Analyse the code with ruff
        run: |
          python3 -m ruff check .