commit	b1bfac3edfe676960d6d01585b5a1d2f9d3f1813	[log] [tgz]
author	Anthony Sottile <asottile@umich.edu>	Fri May 15 08:16:32 2020 -0700
committer	GitHub <noreply@github.com>	Fri May 15 08:16:32 2020 -0700
tree	105f55e96cfb13d0c61578ea0374e1af6416528c
parent	56842c8f208801769f3afe7155622f9eebaec301 [diff]
parent	30b00a6cd975a75c7a08e96f1de0d06a3bdb897b [diff]

tree: 105f55e96cfb13d0c61578ea0374e1af6416528c

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
    - name: set PY
      run: echo "::set-env name=PY::$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')"
    - uses: actions/cache@v1
      with:
        path: ~/.cache/pre-commit
        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
    - uses: pre-commit/action@v1.0.1

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@v1.0.1
      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@v1.0.1
      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!