[v2,09/30] git hook run: add an --ignore-missing flag

Commit Message

Ævar Arnfjörð Bjarmason June 14, 2021, 10:32 a.m. UTC

For certain one-shot hooks we'd like to optimistically run them, and
not complain if they don't exist. This will be used by send-email in a
subsequent commit.

Signed-off-by: Ævar Arnfjörð Bjarmason <[e-mail]>
---
 Documentation/git-hook.txt | 10 +++++++++-
 builtin/hook.c             |  5 +++++
 t/t1800-hook.sh            |  5 +++++
 3 files changed, 19 insertions(+), 1 deletion(-)

Patch

diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt
index 902b9cffaef..1528c860cf1 100644
--- a/Documentation/git-hook.txt
+++ b/Documentation/git-hook.txt
@@ -8,7 +8,7 @@  git-hook - run git hooks
 SYNOPSIS
 --------
 [verse]
-'git hook' run <hook-name> [-- <hook-args>]
+'git hook' run [--ignore-missing] <hook-name> [-- <hook-args>]
 
 DESCRIPTION
 -----------
@@ -27,6 +27,14 @@  run::
 	"--end-of-options"). See "OPTIONS" below for the arguments
 	this accepts.
 
+OPTIONS
+-------
+
+--ignore-missing::
+	Ignore any missing hook by quietly returning zero. Used for
+	tools that want to do a blind one-shot run of a hook that may
+	or may not be present.
+
 SEE ALSO
 --------
 linkgit:githooks[5]
diff --git a/builtin/hook.c b/builtin/hook.c
index 1b1a594fd00..275dd5b0ed0 100644
--- a/builtin/hook.c
+++ b/builtin/hook.c
@@ -16,10 +16,13 @@  static int run(int argc, const char **argv, const char *prefix)
 	int i;
 	struct run_hooks_opt opt = RUN_HOOKS_OPT_INIT;
 	int rc = 0;
+	int ignore_missing = 0;
 	const char *hook_name;
 	const char *hook_path;
 
 	struct option run_options[] = {
+		OPT_BOOL(0, "ignore-missing", &ignore_missing,
+			 N_("exit quietly with a zero exit code if the requested hook cannot be found")),
 		OPT_END(),
 	};
 
@@ -42,6 +45,8 @@  static int run(int argc, const char **argv, const char *prefix)
 	hook_name = argv[1];
 	hook_path = find_hook(hook_name);
 	if (!hook_path) {
+		if (ignore_missing)
+			return 0;
 		error("cannot find a hook named %s", hook_name);
 		return 1;
 	}
diff --git a/t/t1800-hook.sh b/t/t1800-hook.sh
index f6ff6c4a493..714dfd08cd8 100755
--- a/t/t1800-hook.sh
+++ b/t/t1800-hook.sh
@@ -12,6 +12,11 @@  test_expect_success 'git hook run -- nonexistent hook' '
 	test_cmp stderr.expect stderr.actual
 '
 
+test_expect_success 'git hook run -- nonexistent hook with --ignore-missing' '
+	git hook run --ignore-missing does-not-exist 2>stderr.actual &&
+	test_must_be_empty stderr.actual
+'
+
 test_expect_success 'git hook run -- basic' '
 	write_script .git/hooks/test-hook <<-EOF &&
 	echo Test hook