ruff.yml

# This workflow runs the Ruff linter

name: Ruff

on:
  push:
    branches:
      - '**'
  pull_request:
    branches:
      - '**'

permissions:
  contents: write
  id-token: write
  issues: write
  pull-requests: write

jobs:
  ruff:
    runs-on: ubuntu-latest
    steps:

    - name: Checkout repository
      uses: actions/checkout@v7

    - name: Install uv
      uses: astral-sh/setup-uv@v7
      with:
        cache-dependency-glob: "uv.lock"
        enable-cache: true

    - name: Install library and dependencies
      run: uv sync --frozen

    - name: Lint with Ruff
      id: lint
      run: |
        uv run --frozen ruff check --fix .
        echo "RUFF_SUCCESS=$([ $? -eq 0 ])" >> $GITHUB_OUTPUT

    - name: Create Pull Request
      uses: peter-evans/create-pull-request@v8
      if: ${{ !steps.lint.outputs.RUFF_SUCCESS }}
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        title: "Format Python code with Ruff push"
        commit-message: "[PATCH] Ruff auto-format"
        body: |
          There appear to be some python formatting errors in ${{ github.sha }}.
          This pull request uses the Ruff formatter to fix some of these issues.
        base: ${{ github.head_ref }} # Creates pull request onto pull request or commit branch
        branch: actions/ruff