lint.yml

name: Linting

on:
  push:
    paths-ignore:
      - "**.md"
      - "**.rst"
      - "**.ipynb"
      - "**.cff"
    branches:
      - main
      - develop
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
    paths-ignore:
      - "**.md"
      - "**.rst"
      - "**.ipynb"
      - "**.cff"
    branches:
      - main
      - develop

jobs:
  lint:
    if: github.event.pull_request.draft == false
    name: Linting build for (${{ matrix.python-version }}, ${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: ["ubuntu-latest"]
        python-version: ["3.10"]
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v3
        with:
          python-version: ${{ matrix.python-version }}
      - name: Python info
        shell: bash -e {0}
        run: |
          which python3
          python3 --version
      - name: Check linting and formatting using ruff
        run: |
          python3 -m pip install ruff
          ruff check || (echo "Please ensure you have the latest ruff (`ruff -V`) installed locally." && (exit 1))
          ruff format --check || (echo "Please ensure you have the latest ruff (`ruff -V`) installed locally." && (exit 1))