Skip to content

Commit b469434

Browse files
committed
Document the default always_run behaviour of no-commit-to-branch
Include instructions on how to use files/types/excludes/exclude_types with the no-commit-to-branch hook, along with the caveat of it allowing empty commits
1 parent c14b3aa commit b469434

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,13 @@ Protect specific branches from direct checkins.
132132
- `-p` / `--pattern` can be used to protect branches that match a supplied regex
133133
(e.g. `--pattern, release/.*`). May be specified multiple times.
134134

135+
Note that `no-commit-to-branch` is configured by default to [`always_run`](https://pre-commit.com/#config-always_run).
136+
As a result, it will ignore any setting of [`files`](https://pre-commit.com/#config-files),
137+
[`exclude`](https://pre-commit.com/#config-exclude), [`types`](https://pre-commit.com/#config-types)
138+
or [`exclude_types`](https://pre-commit.com/#config-exclude_types).
139+
Set [`always_run: false`](https://pre-commit.com/#config-always_run) to allow this hook to be skipped according to these
140+
file filters. Caveat: In this configuration, empty commits (`git commit --allow-empty`) would always be allowed by this hook.
141+
135142
#### `pretty-format-json`
136143
Checks that all your JSON files are pretty. "Pretty"
137144
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
150157
keys, preserving comments and blocks.
151158

152159
Note that `sort-simple-yaml` by default matches no `files` as it enforces a
153-
very specific format. You must opt in to this by setting `files`, for example:
160+
very specific format. You must opt in to this by setting [`files`](https://pre-commit.com/#config-files), for example:
154161

155162
```yaml
156163
- id: sort-simple-yaml

0 commit comments

Comments
 (0)