From dd0de5c2a3761836333ae42cc0c95bffb5ea279b Mon Sep 17 00:00:00 2001 From: Taufek Johar Date: Mon, 14 Oct 2019 14:27:32 +0800 Subject: [PATCH] Update Doc on "exclude_branch_patterns" config Context - Update readme on above config that was added in below PR. https://github.com/sds/overcommit/pull/681 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index bd064835..b99069f7 100644 --- a/README.md +++ b/README.md @@ -226,6 +226,7 @@ Option | Description `requires_files` | If `true`, this hook runs only if files that are applicable to it have been modified. See `include` and `exclude` for how to specify applicable files. `include` | File paths or glob patterns of files that apply to this hook. The hook will only run on the applicable files when they have been modified. Note that the concept of modified varies for different types of hooks. By default, `include` matches every file until you specify a list of patterns. `exclude` | File paths or glob patterns of files that do not apply to this hook. This is used to exclude any files that would have been matched by `include`. +`exclude_branch_patterns` | List of branch names or glob patterns of branches that do not apply to this hook. `problem_on_unmodified_line` | How to treat errors reported on lines that weren't modified during the action captured by this hook (e.g. for pre-commit hooks, warnings/errors reported on lines that were not staged with `git add` may not be warnings/errors you care about). Valid values are `report`: report errors/warnings as-is regardless of line location (default); `warn`: report errors as warnings if they are on lines you didn't modify; and `ignore`: don't display errors/warnings at all if they are on lines you didn't modify (`ignore` is _not_ recommended). `on_fail` | Change the status of a failed hook to `warn` or `pass`. This allows you to treat failures as warnings or potentially ignore them entirely, but you should use caution when doing so as you might be hiding important information. `on_warn` | Similar to `on_fail`, change the status of a hook that returns a warning status to either `pass` (you wish to silence warnings entirely) or `fail` (you wish to treat all warnings as errors).