actions/pre-commit

ivuorinen/actions/pre-commit

pre-commit

Description

Runs pre-commit on the repository and pushes the fixes back to the repository

Inputs

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

Outputs

name	description
hooks_passed	Whether all pre-commit hooks passed (true/false)
files_changed	Whether any files were changed by pre-commit hooks

Runs

This action is a composite action.

Usage

- uses: ivuorinen/actions/pre-commit@main
  with:
    pre-commit-config:
    # pre-commit configuration file
    #
    # Required: false
    # Default: .pre-commit-config.yaml

    base-branch:
    # Base branch to compare against
    #
    # Required: false
    # Default: ""

    token:
    # GitHub token for authentication
    #
    # Required: false
    # Default: ""

    commit_user:
    # Commit user
    #
    # Required: false
    # Default: GitHub Actions

    commit_email:
    # Commit email
    #
    # Required: false
    # Default: github-actions@github.com