verilator/.github/workflows/format.yml

---
# DESCRIPTION: Github actions config
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
#
name: format
on:
  push:
    branches-ignore:
      - 'dependabot/**'  # Avoid duplicates: only run the PR, not the push

permissions:
  contents: write

defaults:
  run:
    working-directory: repo

concurrency:
  # At most 1 run per branch: the job pushes what 'make format' changed, so
  # concurrent runs on the same branch race on that push. Cancel the run in
  # progress, as the newer one formats a tree that already holds its commits.
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  format:
    runs-on: ubuntu-24.04
    name: Ubuntu 24.04 | format
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7
        with:
          path: repo
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Install packages for build
        uses: ./repo/.github/actions/install-deps
        with:
          stage: format

      - name: Configure git identity
        run: |
          git config --global user.email "[email protected]"
          git config --global user.name "github action"

      - name: Configure
        run: |
          autoconf
          ./configure

      - name: Set up Python venv
        uses: ./repo/.github/actions/setup-venv
        with:
          save: ${{ github.ref == 'refs/heads/master' }}

      - name: Format code
        run: |
          source .venv/bin/activate
          make -j 4 format CLANGFORMAT=clang-format-18
          git status

      - name: Push
        run: |-
          if [ -n "$(git status --porcelain)" ]; then
            git commit . -m "Apply 'make format'" &&
            git push origin
          fi