commit	0764670bf370aab253130d534e1eda7ff497dc60	[log] [tgz]
author	Github Actions <user@example.com>	Sat Jun 13 20:06:21 2020 +0000
committer	Github Actions <user@example.com>	Sat Jun 13 20:06:21 2020 +0000
tree	f62825ed98851a8ce0efded7d80c402f060bf8c6
parent	96e0777fb9104411064c61414e39da02f429551a [diff]

tree: f62825ed98851a8ce0efded7d80c402f060bf8c6

README.md

pre-commit/action

a GitHub action to run pre-commit

using this action

To use this action, make a file .github/workflows/pre-commit.yml. Here's a template to get started:

name: pre-commit

on:
  pull_request:
  push:
    branches: [master]

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: actions/setup-python@v1
    - uses: pre-commit/action@v2.0.0

This does a few things:

clones the code
installs python
sets up the pre-commit cache

Hopefully in the future when actions matures the yaml can be simplified.

using this action with custom invocations

By default, this action runs all the hooks against all the files. extra_args lets users specify a single hook id and/or options to pass to pre-commit run.

Here's a sample step configuration that only runs the flake8 hook against all the files (use the template above except for the pre-commit action):

    - uses: pre-commit/action@v2.0.0
      with:
        extra_args: flake8 --all-files

using this action in private repositories

this action also provides an additional behaviour when used in private repositories. when configured with a github token, the action will push back fixes to the pull request branch.

here's an example configuration for that (use the template above except for the pre-commit action):

    - uses: pre-commit/action@v2.0.0
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

note that secrets.GITHUB_TOKEN is automatically provisioned and will not require any special configuration.

while you could technically configure this for a public repository (using a personal access token), I can't think of a way to do this safely without exposing a privileged token to pull requests -- if you have any ideas, please leave an issue!