format.yml

name: format

on:
  pull_request:
    types: [opened, synchronize, reopened, labeled, unlabeled]

permissions:
  contents: read
  security-events: write

jobs:
  analyze:
    name: Check code formatting
    runs-on: ubuntu-latest
    if: ${{ !contains(github.event.pull_request.labels.*.name, 'ci-skip-format') }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup environment
        uses: ./.github/actions/setup-env

      - name: Run bazel format
        run: |
          # The --include_autogenerated_targets=True is needed to create the autogenerated targets.
          # Without it, bazel wrapper hook scripts append some additional args that break the formatting check.
          bazel run format --include_autogenerated_targets=True -- --origin-branch=origin/${{ github.base_ref }}

      - name: Verify formatting
        run: |
          # Ignore changes to MODULE.bazel.lock as it may be updated by bazel
          git checkout -- MODULE.bazel.lock 2>/dev/null || true
          if ! git diff --quiet; then
            echo "::error::Formatting issues detected."
            echo ""
            echo "Your PR is not properly formatted."
            echo ""
            echo "To fix the problem locally, run:"
            echo ""
            echo "    bazel run format"
            echo ""
            echo "and commit the resulting changes."
            echo ""
            echo "Affected files:"
            git diff --stat
            echo "Diff:"
            git diff | head -n 1000
            exit 1
          fi