pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-04-10 21:34:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #501 from marcjay/document-no-commit-to-branch-always-run

Browse source 
Document the default always_run behaviour of no-commit-to-branch
This commit is contained in:
Anthony Sottile 2020-06-19 13:31:37 -07:00 • committed by GitHub
commit f7dd0c05bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -132,6 +132,13 @@ Protect specific branches from direct checkins.
- `-p` / `--pattern` can be used to protect branches that match a supplied regex - `-p` / `--pattern` can be used to protect branches that match a supplied regex
(e.g. `--pattern, release/.*`). May be specified multiple times. (e.g. `--pattern, release/.*`). May be specified multiple times.
Note that `no-commit-to-branch` is configured by default to [`always_run`](https://pre-commit.com/#config-always_run).
As a result, it will ignore any setting of [`files`](https://pre-commit.com/#config-files),
[`exclude`](https://pre-commit.com/#config-exclude), [`types`](https://pre-commit.com/#config-types)
or [`exclude_types`](https://pre-commit.com/#config-exclude_types).
Set [`always_run: false`](https://pre-commit.com/#config-always_run) to allow this hook to be skipped according to these
file filters. Caveat: In this configuration, empty commits (`git commit --allow-empty`) would always be allowed by this hook.
#### `pretty-format-json` #### `pretty-format-json`
Checks that all your JSON files are pretty. "Pretty" Checks that all your JSON files are pretty. "Pretty"
here means that keys are sorted and indented. You can configure this with here means that keys are sorted and indented. You can configure this with
@ -150,7 +157,7 @@ Sorts simple YAML files which consist only of top-level
keys, preserving comments and blocks. keys, preserving comments and blocks.
Note that `sort-simple-yaml` by default matches no `files` as it enforces a Note that `sort-simple-yaml` by default matches no `files` as it enforces a
very specific format. You must opt in to this by setting `files`, for example: very specific format. You must opt in to this by setting [`files`](https://pre-commit.com/#config-files), for example:
```yaml ```yaml
- id: sort-simple-yaml - id: sort-simple-yaml