format.yml

name: Format check

on:
  pull_request:
    branches:
      - main
    paths:
      - '**.py'

jobs:
  find-changed-files:
    runs-on: ubuntu-latest
    outputs:
      files: ${{ steps.git-diff-files.outputs.files }}
    name: Detect added and changed files

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Create json diff
        uses: GrantBirki/git-diff-action@v2
        id: git-diff
        with:
          base_branch: origin/main
          search_path: '**.py'
          json_diff_file_output: diff.json
          file_output_only: 'true'
          # Ignore deleted files
          git_options: '--no-color --diff-filter=d'

      - name: Convert json diff to matrix array
        id: git-diff-files
        env:
          JSON_DIFF: ${{ steps.git-diff.outputs.json-diff-path }}
        run: |
          # Github output expects oneliners, use compact mode
          files=$(cat $JSON_DIFF | jq -c -r '[.files[] | {path: .path}]')
          echo "files=$files" >> $GITHUB_OUTPUT

  ruff-format:
    needs: find-changed-files
    if: ${{ needs.find-changed-files.outputs.files != '[]' }}
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        files: ${{ fromJSON(needs.find-changed-files.outputs.files) }}

    name: Check file ${{ matrix.files.path }}
    steps:
      - uses: actions/checkout@v4

      - name: Run ruff format check for ${{ matrix.files.path }}
        id: format-check
        uses: astral-sh/ruff-action@v1
        # Allow the job run to pass when this step fails
        continue-on-error: true
        with:
          args: "format --check --diff"
          src: "${{ matrix.files.path }}"
          version: 0.8.1

      - name: Annotate unformatted file
        if: ${{ steps.format-check.outcome }} == 'failure'
        env:
          JOB_URL: "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"
        run: |
          echo "::notice file=${{ matrix.files.path }},title=Unformatted file::Consider running 'ruff format ${{ matrix.files.path }}'%0ASee $JOB_URL for more details"