If a user wants a specific repo to skip execution of a hook which is set
at a global or system level, they will be able to do so by specifying
'skip' in their repo config:
~/.gitconfig
[hook.pre-commit]
command = skippable-oneliner
command = skippable-hookcmd
[hookcmd.skippable-hookcmd]
command = foo.sh
$GIT_DIR/.git/config
[hookcmd.skippable-oneliner]
skip = true
[hookcmd.skippable-hookcmd]
skip = true
Later it may make sense to add an option like
"hookcmd.<name>.<hook-event>-skip" - but for simplicity, let's start
with a universal skip setting like this.
Signed-off-by: Emily Shaffer <emilyshaffer@xxxxxxxxxx>
---
Documentation/config/hook.txt | 8 ++++++++
Documentation/git-hook.txt | 33 +++++++++++++++++++++++++++++++++
hook.c | 35 ++++++++++++++++++++++++++---------
t/t1360-config-based-hooks.sh | 35 +++++++++++++++++++++++++++++++++++
4 files changed, 102 insertions(+), 9 deletions(-)
diff --git a/Documentation/config/hook.txt b/Documentation/config/hook.txt
index 75312754ae..8b12512e33 100644
--- a/Documentation/config/hook.txt
+++ b/Documentation/config/hook.txt
@@ -8,6 +8,14 @@ hookcmd.<name>.command::
as a command. This can be an executable on your device or a oneliner for
your shell. See linkgit:git-hook[1].
+hookcmd.<name>.skip::
+ Specify this boolean to remove a command from earlier in the execution
+ order. Useful if you want to make a single repo an exception to hook
+ configured at the system or global scope. If there is no hookcmd
+ specified for the command you want to skip, you can use the value of
+ `hook.<command>.command` as <name> as a shortcut. The "skip" setting
+ must be specified after the "hook.<command>.command" to have an effect.
+
hook.runHookDir::
Controls how hooks contained in your hookdir are executed. Can be any of
"yes", "warn", "interactive", or "no". Defaults to "yes". See
diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt
index f19875ed68..c84520cb38 100644
--- a/Documentation/git-hook.txt
+++ b/Documentation/git-hook.txt
@@ -54,6 +54,39 @@ $ git hook list "prepare-commit-msg"
local: /bin/linter --c
----
+If there is a command you wish to run in most cases but have one or two
+exceptional repos where it should be skipped, you can use specify
+`hookcmd.<name>.skip`, for example:
+
+System config
+----
+ [hook "pre-commit"]
+ command = check-for-secrets
+
+ [hookcmd "check-for-secrets"]
+ command = /bin/secret-checker --aggressive
+----
+
+Local config
+----
+ [hookcmd "check-for-secrets"]
+ skip = true
+ # This works for inlined hook commands, too:
+ [hookcmd "~/typocheck.sh"]
+ skip = true
+----
+
+After these configs are added, the hook list becomes:
+
+----
+$ git hook list "post-commit"
+global: /bin/linter --c
+local: python ~/run-test-suite.py
+
+$ git hook list "pre-commit"
+no commands configured for hook 'pre-commit'
+----
+
COMMANDS
--------
diff --git a/hook.c b/hook.c
index 039ff0a378..37b740d58d 100644
--- a/hook.c
+++ b/hook.c
@@ -12,24 +12,25 @@ void free_hook(struct hook *ptr)
}
}
-static void append_or_move_hook(struct list_head *head, const char *command)
+static struct hook * find_hook_by_command(struct list_head *head, const char *command)
{
struct list_head *pos = NULL, *tmp = NULL;
- struct hook *to_add = NULL;
+ struct hook *found = NULL;
- /*
- * remove the prior entry with this command; we'll replace it at the
- * end.
- */
list_for_each_safe(pos, tmp, head) {
struct hook *it = list_entry(pos, struct hook, list);
if (!strcmp(it->command.buf, command)) {
list_del(pos);
- /* we'll simply move the hook to the end */
- to_add = it;
+ found = it;
break;
}
}
+ return found;
+}
+
+static void append_or_move_hook(struct list_head *head, const char *command)
+{
+ struct hook *to_add = find_hook_by_command(head, command);
if (!to_add) {
/* adding a new hook, not moving an old one */
@@ -74,12 +75,22 @@ static int hook_config_lookup(const char *key, const char *value, void *cb_data)
if (!strcmp(key, hook_key)) {
const char *command = value;
struct strbuf hookcmd_name = STRBUF_INIT;
+ int skip = 0;
+
+ /*
+ * Check if we're removing that hook instead. Hookcmds are
+ * removed by name, and inlined hooks are removed by command
+ * content.
+ */
+ strbuf_addf(&hookcmd_name, "hookcmd.%s.skip", command);
+ git_config_get_bool(hookcmd_name.buf, &skip);
/*
* Check if a hookcmd with that name exists. If it doesn't,
* 'git_config_get_value()' is documented not to touch &command,
* so we don't need to do anything.
*/
+ strbuf_reset(&hookcmd_name);
strbuf_addf(&hookcmd_name, "hookcmd.%s.command", command);
git_config_get_value(hookcmd_name.buf, &command);
@@ -94,7 +105,13 @@ static int hook_config_lookup(const char *key, const char *value, void *cb_data)
* for each key+value, do_callback(key, value, cb_data)
*/
- append_or_move_hook(head, command);
+ if (skip) {
+ struct hook *to_remove = find_hook_by_command(head, command);
+ if (to_remove)
+ remove_hook(&(to_remove->list));
+ } else {
+ append_or_move_hook(head, command);
+ }
strbuf_release(&hookcmd_name);
}
diff --git a/t/t1360-config-based-hooks.sh b/t/t1360-config-based-hooks.sh
index 66b0b6b7ad..a9b1b046c1 100755
--- a/t/t1360-config-based-hooks.sh
+++ b/t/t1360-config-based-hooks.sh
@@ -146,6 +146,41 @@ test_expect_success 'hook.runHookDir = warn is respected by list' '
test_i18ncmp expected actual
'
+test_expect_success 'git hook list removes skipped hookcmd' '
+ setup_hookcmd &&
+ test_config hookcmd.abc.skip "true" --add &&
+
+ cat >expected <<-EOF &&
+ no commands configured for hook '\''pre-commit'\''
+ EOF
+
+ git hook list pre-commit >actual &&
+ test_i18ncmp expected actual
+'
+
+test_expect_success 'git hook list ignores skip referring to unused hookcmd' '
+ test_config hookcmd.abc.command "/path/abc" --add &&
+ test_config hookcmd.abc.skip "true" --add &&
+
+ cat >expected <<-EOF &&
+ no commands configured for hook '\''pre-commit'\''
+ EOF
+
+ git hook list pre-commit >actual &&
+ test_i18ncmp expected actual
+'
+
+test_expect_success 'git hook list removes skipped inlined hook' '
+ setup_hooks &&
+ test_config hookcmd."$ROOT/path/ghi".skip "true" --add &&
+
+ cat >expected <<-EOF &&
+ global: $ROOT/path/def
+ EOF
+
+ git hook list pre-commit >actual &&
+ test_cmp expected actual
+'
test_expect_success 'hook.runHookDir = interactive is respected by list' '
setup_hookdir &&
--
2.31.0.rc2.261.g7f71774620-goog
