ci.yml

name: CI

on: [push, pull_request]

# Lint code using flake8 and run unit tests using pytest
jobs:
  lint:
    # Tie runner to Ubuntu 22.04 LTS, as it still supports Python 3.7
    # Minimum Python version on Ubuntu 24.04 LTS is Python 3.9.
    runs-on: ubuntu-22.04
    name: Run Linter
    steps:
      - name: Check out source repository
        uses: actions/checkout@v6

      # Cached for subsequent steps, see:
      # https://github.com/actions/setup-python#caching-packages-dependencies
      - name: Set up Python environment
        uses: actions/setup-python@v6
        with:
          python-version: "3.7"
          cache: "pip"

      # TODO: GitHub to deprecate Node 20 in June 2026. Unfortunately, this action does
      # not offer an updated version, so will need to investigate an alternative or updated fork.
      # https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
      # https://github.com/py-actions/flake8/issues/252
      - name: flake8 Lint
        uses: py-actions/flake8@v2
        with:
          plugins: "flake8-bugbear"

  help-check:
    # Tie runner to Ubuntu 22.04 LTS, as it still supports Python 3.7
    # Minimum Python version on Ubuntu 24.04 LTS is Python 3.9.
    runs-on: ubuntu-22.04
    name: Help and Help Summary Check
    steps:
      - name: Check out source repository
        uses: actions/checkout@v6

      # Cached for subsequent steps, see:
      # https://github.com/actions/setup-python#caching-packages-dependencies
      - name: Set up Python environment
        uses: actions/setup-python@v6
        with:
          python-version: "3.7"
          cache: "pip"

      - name: Install all py-scripts dependencies
        run: python py-scripts/update_dependencies.py

      - name: Run help check
        run: |
          cd py-scripts
          python tools/lf_help_check.py