commit | f2f2263f6d717746ef6fb72eaa249750e23bb2cd | [log] [tgz] |
---|---|---|
author | Anthony Sottile <asottile@umich.edu> | Wed Jun 10 13:33:14 2020 -0700 |
committer | GitHub <noreply@github.com> | Wed Jun 10 13:33:14 2020 -0700 |
tree | 12a0a8ad0aff43505860cb20d233e2dd58690ddd | |
parent | 771019abd66cc479f5d970869d778ec7ed488a89 [diff] | |
parent | 9890cdb47ca52d8ea07e29865a1c755229fe05c4 [diff] |
Merge pull request #33 from pre-commit/upgrade_packages upgrade packages
a GitHub action to run pre-commit
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.1.0
This does a few things:
pre-commit
cacheHopefully in the future when actions
matures the yaml can be simplified.
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.1.0 with: extra_args: flake8 --all-files
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.1.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!