mirror of
https://github.com/pre-commit/action.git
synced 2025-11-07 18:56:55 +00:00
Deployed to github pages
This commit is contained in:
parent
78b094032d
commit
0c6039fa09
3 changed files with 20 additions and 2 deletions
14
README.md
14
README.md
|
|
@ -41,6 +41,20 @@ This does a few things:
|
||||||
|
|
||||||
Hopefully in the future when `actions` matures the yaml can be simplified.
|
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):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: pre-commit/action@v1.0.1
|
||||||
|
with:
|
||||||
|
extra_args: flake8 --all-files
|
||||||
|
```
|
||||||
|
|
||||||
### using this action in private repositories
|
### using this action in private repositories
|
||||||
|
|
||||||
this action also provides an additional behaviour when used in private
|
this action also provides an additional behaviour when used in private
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,10 @@
|
||||||
name: pre-commit
|
name: pre-commit
|
||||||
description: run pre-commit and optionally commit back to the pull request
|
description: run pre-commit and optionally commit back to the pull request
|
||||||
inputs:
|
inputs:
|
||||||
|
extra_args:
|
||||||
|
description: options to pass to pre-commit run
|
||||||
|
required: false
|
||||||
|
default: '--all-files'
|
||||||
token:
|
token:
|
||||||
description: github token to clone / push with
|
description: github token to clone / push with
|
||||||
required: false
|
required: false
|
||||||
|
|
|
||||||
4
dist/index.js
vendored
4
dist/index.js
vendored
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue