actions/pre-commit/action.yml

# yaml-language-server: $schema=https://json.schemastore.org/github-action.json
# permissions:
#   - contents: write  # Required for pushing fixes back to repository
---
name: pre-commit
description: 'Runs pre-commit on the repository and pushes the fixes back to the repository'
author: 'Ismo Vuorinen'

branding:
  icon: check-square
  color: green

inputs:
  pre-commit-config:
    description: 'pre-commit configuration file'
    required: false
    default: '.pre-commit-config.yaml'
  base-branch:
    description: 'Base branch to compare against'
    required: false
  token:
    description: 'GitHub token for authentication'
    required: false
    default: ''
  commit_user:
    description: 'Commit user'
    required: false
    default: 'GitHub Actions'
  commit_email:
    description: 'Commit email'
    required: false
    default: 'github-actions@github.com'

outputs:
  hooks_passed:
    description: 'Whether all pre-commit hooks passed (true/false)'
    value: ${{ steps.pre-commit.outcome == 'success' }}
  files_changed:
    description: 'Whether any files were changed by pre-commit hooks'
    value: ${{ steps.push-fixes.outputs.changes_detected }}

runs:
  using: composite
  steps:
    - name: Checkout Repository
      uses: actions/checkout@71cf2267d89c5cb81562390fa70a37fa40b1305e # v6-beta
      with:
        token: ${{ inputs.token || github.token }}

    - name: Validate Inputs
      id: validate
      uses: ivuorinen/actions/validate-inputs@0fa9a68f07a1260b321f814202658a6089a43d42
      with:
        action-type: 'pre-commit'
        token: ${{ inputs.token }}
        pre-commit-config: ${{ inputs.pre-commit-config }}
        base-branch: ${{ inputs.base-branch }}
        email: ${{ inputs.commit_email }}
        username: ${{ inputs.commit_user }}
    - name: Set Git Config
      uses: ivuorinen/actions/set-git-config@0fa9a68f07a1260b321f814202658a6089a43d42
      with:
        token: ${{ inputs.token }}
        username: ${{ inputs.commit_user }}
        email: ${{ inputs.commit_email }}

    - name: Set option
      id: set-option
      shell: bash
      env:
        BASE_BRANCH: ${{ inputs.base-branch }}
      run: |
        set -euo pipefail

        if [ -z "$BASE_BRANCH" ]; then
          echo "option=--all-files" >> $GITHUB_OUTPUT
          exit 0
        fi
        echo "option=--from-ref $BASE_BRANCH --to-ref HEAD" >> $GITHUB_OUTPUT

    - name: Run pre-commit
      id: pre-commit
      uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
      env:
        PRE_COMMIT_USE_UV: '1'
      with:
        extra_args: --config ${{ inputs.pre-commit-config }} ${{ steps.set-option.outputs.option }}

    - name: Push pre-commit fixes
      id: push-fixes
      if: always() # Push changes even when pre-commit fails
      uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3 # v7.0.0
      with:
        commit_message: 'style(pre-commit): autofix'
        add_options: -u