From: Emily Shaffer <emilyshaffer@google.com>
To: git@vger.kernel.org
Cc: Emily Shaffer <emilyshaffer@google.com>
Subject: [PATCH v5 5/8] hook: implement hookcmd.<name>.skip
Date: Wed, 14 Oct 2020 16:24:44 -0700 [thread overview]
Message-ID: <20201014232447.3050579-6-emilyshaffer@google.com> (raw)
In-Reply-To: <20201014232447.3050579-1-emilyshaffer@google.com>
If a user wants a specific repo to skip execution of a hook which is set
at a global or system level, they can now 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@google.com>
---
Notes:
New since v4.
During the Google team's review club I was reminded about this whole
'skip' option I never implemented. It's true that it's impossible to
exclude a given hook without this; however, I think I have some more
work to do on it, so consider it RFC for now and tell me what you think
:)
- Emily
hook.c | 37 +++++++++++++++++++++++++----------
t/t1360-config-based-hooks.sh | 23 ++++++++++++++++++++++
2 files changed, 50 insertions(+), 10 deletions(-)
diff --git a/hook.c b/hook.c
index 340e5a35c8..f4084e33c8 100644
--- a/hook.c
+++ b/hook.c
@@ -12,23 +12,24 @@ 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;
}
}
+ 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 */
@@ -41,7 +42,7 @@ static void append_or_move_hook(struct list_head *head, const char *command)
/* re-set the scope so we show where an override was specified */
to_add->origin = current_config_scope();
- list_add_tail(&to_add->list, pos);
+ list_add_tail(&to_add->list, head);
}
static void remove_hook(struct list_head *to_remove)
@@ -73,8 +74,18 @@ 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. */
+ strbuf_reset(&hookcmd_name);
strbuf_addf(&hookcmd_name, "hookcmd.%s.command", command);
git_config_get_value(hookcmd_name.buf, &command);
@@ -89,7 +100,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 91127a50a4..ebd3bc623f 100755
--- a/t/t1360-config-based-hooks.sh
+++ b/t/t1360-config-based-hooks.sh
@@ -132,6 +132,29 @@ 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 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.28.0.rc0.142.g3c755180ce-goog
next prev parent reply other threads:[~2020-10-15 1:54 UTC|newest]
Thread overview: 170+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-21 18:54 [PATCH v2 0/4] propose config-based hooks Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 1/4] doc: propose hooks managed by the config Emily Shaffer
2020-05-22 10:13 ` Phillip Wood
2020-06-09 20:26 ` Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 2/4] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 3/4] hook: add list command Emily Shaffer
2020-05-22 10:27 ` Phillip Wood
2020-06-09 21:49 ` Emily Shaffer
2020-08-17 13:36 ` Phillip Wood
2020-05-24 23:00 ` Johannes Schindelin
2020-05-27 23:37 ` Emily Shaffer
2020-05-21 18:54 ` [PATCH v2 4/4] hook: add --porcelain to " Emily Shaffer
2020-05-24 23:00 ` Johannes Schindelin
2020-05-25 0:29 ` Johannes Schindelin
2020-07-28 22:24 ` [PATCH v3 0/6] propose config-based hooks Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 1/6] doc: propose hooks managed by the config Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 2/6] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 3/6] hook: add list command Emily Shaffer
2020-07-28 22:24 ` [PATCH v3 4/6] hook: add --porcelain to " Emily Shaffer
2020-07-28 22:24 ` [RFC PATCH v3 5/6] parse-options: parse into argv_array Emily Shaffer
2020-07-29 19:33 ` Junio C Hamano
2020-07-30 23:41 ` Junio C Hamano
2020-07-28 22:24 ` [RFC PATCH v3 6/6] hook: add 'run' subcommand Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 0/9] propose config-based hooks Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 1/9] doc: propose hooks managed by the config Emily Shaffer
2020-09-23 22:59 ` Jonathan Tan
2020-09-24 21:54 ` Emily Shaffer
2020-10-07 9:23 ` Ævar Arnfjörð Bjarmason
2020-10-22 0:58 ` Emily Shaffer
2020-10-23 19:10 ` Ævar Arnfjörð Bjarmason
2020-10-29 15:38 ` Emily Shaffer
2020-10-29 20:04 ` Ævar Arnfjörð Bjarmason
2020-09-09 0:49 ` [PATCH v4 2/9] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-10-05 23:24 ` Jonathan Nieder
2020-10-06 19:06 ` Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 3/9] hook: add list command Emily Shaffer
2020-09-11 13:27 ` Phillip Wood
2020-09-11 16:51 ` Emily Shaffer
2020-09-23 23:04 ` Jonathan Tan
2020-10-06 20:46 ` Emily Shaffer
2020-09-27 19:23 ` Martin Ågren
2020-10-06 20:20 ` Emily Shaffer
2020-10-05 23:27 ` Jonathan Nieder
2020-09-09 0:49 ` [PATCH v4 4/9] hook: add --porcelain to " Emily Shaffer
2020-09-28 19:29 ` Josh Steadmon
2020-09-09 0:49 ` [PATCH v4 5/9] parse-options: parse into strvec Emily Shaffer
2020-10-05 23:30 ` Jonathan Nieder
2020-10-06 4:49 ` Junio C Hamano
2020-09-09 0:49 ` [PATCH v4 6/9] hook: add 'run' subcommand Emily Shaffer
2020-09-11 13:30 ` Phillip Wood
2020-09-28 19:29 ` Josh Steadmon
2020-10-05 23:39 ` Jonathan Nieder
2020-10-06 22:57 ` Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 7/9] hook: replace run-command.h:find_hook Emily Shaffer
2020-09-09 20:32 ` Junio C Hamano
2020-09-10 19:08 ` Emily Shaffer
2020-09-23 23:20 ` Jonathan Tan
2020-10-05 23:42 ` Jonathan Nieder
2020-09-09 0:49 ` [PATCH v4 8/9] commit: use config-based hooks Emily Shaffer
2020-09-10 13:50 ` Phillip Wood
2020-09-10 22:21 ` Junio C Hamano
2020-09-23 23:47 ` Jonathan Tan
2020-10-05 21:27 ` Emily Shaffer
2020-10-05 23:48 ` Jonathan Nieder
2020-10-06 19:08 ` Emily Shaffer
2020-09-09 0:49 ` [PATCH v4 9/9] run_commit_hook: take strvec instead of varargs Emily Shaffer
2020-09-10 14:16 ` Phillip Wood
2020-09-11 13:20 ` Phillip Wood
2020-09-09 21:04 ` [PATCH v4 0/9] propose config-based hooks Junio C Hamano
2020-10-14 23:24 ` [PATCH v5 0/8] propose config-based hooks (part I) Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 1/8] doc: propose hooks managed by the config Emily Shaffer
2020-10-15 16:31 ` Ævar Arnfjörð Bjarmason
2020-10-16 17:29 ` Junio C Hamano
2020-10-21 23:37 ` Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 2/8] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 3/8] hook: add list command Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 4/8] hook: include hookdir hook in list Emily Shaffer
2020-10-14 23:24 ` Emily Shaffer [this message]
2020-10-14 23:24 ` [PATCH v5 6/8] parse-options: parse into strvec Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 7/8] hook: add 'run' subcommand Emily Shaffer
2020-10-14 23:24 ` [PATCH v5 8/8] hook: replace find_hook() with hook_exists() Emily Shaffer
2020-12-05 1:45 ` [PATCH v6 00/17] propose config-based hooks (part I) Emily Shaffer
2020-12-05 1:45 ` [PATCH 01/17] doc: propose hooks managed by the config Emily Shaffer
2020-12-05 1:45 ` [PATCH 02/17] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-12-05 1:45 ` [PATCH 03/17] hook: add list command Emily Shaffer
2020-12-05 1:45 ` [PATCH 04/17] hook: include hookdir hook in list Emily Shaffer
2020-12-05 1:45 ` [PATCH 05/17] hook: respect hook.runHookDir Emily Shaffer
2020-12-05 1:45 ` [PATCH 06/17] hook: implement hookcmd.<name>.skip Emily Shaffer
2020-12-05 1:45 ` [PATCH 07/17] parse-options: parse into strvec Emily Shaffer
2020-12-05 1:45 ` [PATCH 08/17] hook: add 'run' subcommand Emily Shaffer
2020-12-11 10:15 ` Phillip Wood
2020-12-15 21:41 ` Emily Shaffer
2020-12-05 1:45 ` [PATCH 09/17] hook: replace find_hook() with hook_exists() Emily Shaffer
2020-12-05 1:46 ` [PATCH 10/17] hook: support passing stdin to hooks Emily Shaffer
2020-12-05 1:46 ` [PATCH 11/17] run-command: allow stdin for run_processes_parallel Emily Shaffer
2020-12-05 1:46 ` [PATCH 12/17] hook: allow parallel hook execution Emily Shaffer
2020-12-05 1:46 ` [PATCH 13/17] hook: allow specifying working directory for hooks Emily Shaffer
2020-12-05 1:46 ` [PATCH 14/17] run-command: add stdin callback for parallelization Emily Shaffer
2020-12-05 1:46 ` [PATCH 15/17] hook: provide stdin by string_list or callback Emily Shaffer
2020-12-08 21:09 ` SZEDER Gábor
2020-12-08 22:11 ` Emily Shaffer
2020-12-05 1:46 ` [PATCH 16/17] run-command: allow capturing of collated output Emily Shaffer
2020-12-05 1:46 ` [PATCH 17/17] hooks: allow callers to capture output Emily Shaffer
2020-12-16 0:34 ` [PATCH v6 00/17] propose config-based hooks (part I) Josh Steadmon
2020-12-16 0:56 ` Junio C Hamano
2020-12-16 20:16 ` Emily Shaffer
2020-12-16 23:32 ` Junio C Hamano
2020-12-18 2:07 ` Emily Shaffer
2020-12-18 5:29 ` Junio C Hamano
2020-12-22 0:02 ` [PATCH v7 " Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 01/17] doc: propose hooks managed by the config Emily Shaffer
2021-01-23 15:38 ` Ævar Arnfjörð Bjarmason
2021-01-29 23:52 ` Emily Shaffer
2021-02-01 22:11 ` Junio C Hamano
2021-03-10 19:30 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 02/17] hook: scaffolding for git-hook subcommand Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 03/17] hook: add list command Emily Shaffer
2021-01-31 3:10 ` Jonathan Tan
2021-02-09 21:06 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 04/17] hook: include hookdir hook in list Emily Shaffer
2021-01-31 3:20 ` Jonathan Tan
2021-02-09 22:05 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 05/17] hook: respect hook.runHookDir Emily Shaffer
2021-01-31 3:35 ` Jonathan Tan
2021-02-09 22:31 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 06/17] hook: implement hookcmd.<name>.skip Emily Shaffer
2021-01-31 3:40 ` Jonathan Tan
2021-02-09 22:57 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 07/17] parse-options: parse into strvec Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 08/17] hook: add 'run' subcommand Emily Shaffer
2021-01-31 4:22 ` Jonathan Tan
2021-02-11 22:44 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 09/17] hook: replace find_hook() with hook_exists() Emily Shaffer
2021-01-31 4:39 ` Jonathan Tan
2021-02-12 22:15 ` Emily Shaffer
2021-02-18 22:23 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 10/17] hook: support passing stdin to hooks Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 11/17] run-command: allow stdin for run_processes_parallel Emily Shaffer
2021-02-01 5:38 ` Jonathan Tan
2021-02-19 20:23 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 12/17] hook: allow parallel hook execution Emily Shaffer
2021-02-01 6:04 ` Jonathan Tan
2021-02-22 21:46 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 13/17] hook: allow specifying working directory for hooks Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 14/17] run-command: add stdin callback for parallelization Emily Shaffer
2021-02-01 6:51 ` Jonathan Tan
2021-02-22 23:38 ` Emily Shaffer
2021-02-23 19:33 ` Jonathan Tan
2021-03-10 18:24 ` Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 15/17] hook: provide stdin by string_list or callback Emily Shaffer
2021-02-01 7:04 ` Jonathan Tan
2021-02-23 19:52 ` Emily Shaffer
2021-02-25 20:56 ` Jonathan Tan
2021-03-02 1:47 ` Emily Shaffer
2021-03-02 23:33 ` Jonathan Tan
2020-12-22 0:02 ` [PATCH v7 16/17] run-command: allow capturing of collated output Emily Shaffer
2020-12-22 0:02 ` [PATCH v7 17/17] hooks: allow callers to capture output Emily Shaffer
2020-12-22 2:11 ` [PATCH v7 00/17] propose config-based hooks (part I) Junio C Hamano
2020-12-28 18:34 ` Emily Shaffer
2020-12-28 22:50 ` Junio C Hamano
2020-12-28 22:37 ` [PATCH v3 18/17] doc: make git-hook.txt point of truth Emily Shaffer
2020-12-28 22:39 ` Emily Shaffer
2021-01-29 23:59 ` [PATCH v7 00/17] propose config-based hooks (part I) Emily Shaffer
2021-02-16 19:46 ` Josh Steadmon
2021-02-16 22:47 ` Junio C Hamano
2021-02-17 21:21 ` Josh Steadmon
2021-02-17 23:07 ` Junio C Hamano
2021-02-25 19:50 ` Junio C Hamano
2021-03-01 21:51 ` Emily Shaffer
2021-03-01 22:19 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201014232447.3050579-6-emilyshaffer@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).