Skip to content

Commit

Permalink
docs: usage: clarify optional configuration (#404)
Browse files Browse the repository at this point in the history
  • Loading branch information
woodruffw authored Jan 7, 2025
1 parent 907e2c8 commit b7e518e
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,19 +464,16 @@ To do so, add the following to your `.pre-commit-config.yaml` `repos` section:

1. Don't forget to update this version to the latest `zizmor` release!

This will run `zizmor` on every commit. If you want to run `zizmor` only on
specific files, you can use the `files` option:
This will run `zizmor` on every commit.

```yaml
- repo:
...
hooks:
- id: zizmor
files: ^path/to/audit/.*\.yml$
```
!!! tip

If you want to run `zizmor` only on specific files, you can use the
`files` option. This setting is *optional*, as `zizmor` will
scan the entire repository by default.

See [`pre-commit`](https://pre-commit.com/) documentation for more information on how to configure
`pre-commit`.
See [`pre-commit`](https://pre-commit.com/) documentation for more
information on how to configure `pre-commit`.

## Limitations

Expand Down

0 comments on commit b7e518e

Please sign in to comment.