| Message ID | 20200521185414.43760-5-emilyshaffer@google.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | propose config-based hooks | expand |
Hi Emily, On Thu, 21 May 2020, Emily Shaffer wrote: > diff --git a/t/t1360-config-based-hooks.sh b/t/t1360-config-based-hooks.sh > index 4e46d7dd4e..3296d8af45 100755 > --- a/t/t1360-config-based-hooks.sh > +++ b/t/t1360-config-based-hooks.sh > @@ -55,4 +55,15 @@ test_expect_success 'git hook list reorders on duplicate commands' ' > test_cmp expected actual > ' > > +test_expect_success 'git hook list --porcelain prints just the command' ' > + cat >expected <<-\EOF && > + /path/ghi > + /path/abc > + /path/def > + EOF > + > + git hook list --porcelain pre-commit >actual && > + test_cmp expected actual > +' As you surely found out from the GitHub workflow running in your fork, this does not work on Windows. I need this (and strongly suggest you squash that into your patch): -- snipsnap -- From 97e3dfa6155785363c881ce2dcaf4f5ddead83ed Mon Sep 17 00:00:00 2001 From: Johannes Schindelin <johannes.schindelin@gmx.de> Date: Mon, 25 May 2020 15:04:24 +0200 Subject: [PATCH] fixup??? hook: add --porcelain to list command This is required to let the test pass on Windows, where Git reports Windows-style absolute paths and has no idea about the pseudo Unix absolute paths that the Bash knows about. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> --- t/t1360-config-based-hooks.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/t/t1360-config-based-hooks.sh b/t/t1360-config-based-hooks.sh index c862655fd4d9..fce7335e97b9 100755 --- a/t/t1360-config-based-hooks.sh +++ b/t/t1360-config-based-hooks.sh @@ -65,10 +65,10 @@ test_expect_success 'git hook list reorders on duplicate commands' ' ' test_expect_success 'git hook list --porcelain prints just the command' ' - cat >expected <<-EOF && - $ROOT/path/ghi - $ROOT/path/abc - $ROOT/path/def + cat >expected <<-\EOF && + /path/ghi + /path/abc + /path/def EOF git hook list --porcelain pre-commit >actual && -- 2.27.0.rc1.windows.1
Hi Emily, On Mon, 25 May 2020, Johannes Schindelin wrote: > Hi Emily, > > On Thu, 21 May 2020, Emily Shaffer wrote: > > > diff --git a/t/t1360-config-based-hooks.sh b/t/t1360-config-based-hooks.sh > > index 4e46d7dd4e..3296d8af45 100755 > > --- a/t/t1360-config-based-hooks.sh > > +++ b/t/t1360-config-based-hooks.sh > > @@ -55,4 +55,15 @@ test_expect_success 'git hook list reorders on duplicate commands' ' > > test_cmp expected actual > > ' > > > > +test_expect_success 'git hook list --porcelain prints just the command' ' > > + cat >expected <<-\EOF && > > + /path/ghi > > + /path/abc > > + /path/def > > + EOF > > + > > + git hook list --porcelain pre-commit >actual && > > + test_cmp expected actual > > +' > > As you surely found out from the GitHub workflow running in your fork, > this does not work on Windows. I need this (and strongly suggest you > squash that into your patch): > > -- snipsnap -- > From 97e3dfa6155785363c881ce2dcaf4f5ddead83ed Mon Sep 17 00:00:00 2001 > From: Johannes Schindelin <johannes.schindelin@gmx.de> > Date: Mon, 25 May 2020 15:04:24 +0200 > Subject: [PATCH] fixup??? hook: add --porcelain to list command > > This is required to let the test pass on Windows, where Git reports > Windows-style absolute paths and has no idea about the pseudo Unix > absolute paths that the Bash knows about. > > Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> > --- > t/t1360-config-based-hooks.sh | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/t/t1360-config-based-hooks.sh b/t/t1360-config-based-hooks.sh > index c862655fd4d9..fce7335e97b9 100755 > --- a/t/t1360-config-based-hooks.sh > +++ b/t/t1360-config-based-hooks.sh > @@ -65,10 +65,10 @@ test_expect_success 'git hook list reorders on duplicate commands' ' > ' > > test_expect_success 'git hook list --porcelain prints just the command' ' > - cat >expected <<-EOF && > - $ROOT/path/ghi > - $ROOT/path/abc > - $ROOT/path/def > + cat >expected <<-\EOF && > + /path/ghi > + /path/abc > + /path/def Due to an oversight on my part, this is actually the _reverse_ diff, and the corresponding part in my mail answering your PATCH 3/4 should be skipped from that fixup. Sorry for that. Ciao, Dscho > EOF > > git hook list --porcelain pre-commit >actual && > -- > 2.27.0.rc1.windows.1 > >
diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt index e458586e96..0854035ce2 100644 --- a/Documentation/git-hook.txt +++ b/Documentation/git-hook.txt @@ -8,7 +8,7 @@ git-hook - Manage configured hooks SYNOPSIS -------- [verse] -'git hook' list <hook-name> +'git hook' list [--porcelain] <hook-name> DESCRIPTION ----------- @@ -43,11 +43,20 @@ Local config COMMANDS -------- -list <hook-name>:: +list [--porcelain] <hook-name>:: List the hooks which have been configured for <hook-name>. Hooks appear in the order they should be run, and note the config scope where the relevant `hook.<hook-name>.command` was specified, not the `hookcmd` (if applicable). ++ +If `--porcelain` is specified, instead print the commands alone, separated by +newlines, for easy parsing by a script. + +OPTIONS +------- +--porcelain:: + With `list`, print the commands in the order they should be run, + separated by newlines, for easy parsing by a script. GIT --- diff --git a/builtin/hook.c b/builtin/hook.c index cfd8e388bd..2e51c84c81 100644 --- a/builtin/hook.c +++ b/builtin/hook.c @@ -16,8 +16,11 @@ static int list(int argc, const char **argv, const char *prefix) struct list_head *head, *pos; struct hook *item; struct strbuf hookname = STRBUF_INIT; + int porcelain = 0; struct option list_options[] = { + OPT_BOOL(0, "porcelain", &porcelain, + "format for execution by a script"), OPT_END(), }; @@ -29,6 +32,8 @@ static int list(int argc, const char **argv, const char *prefix) builtin_hook_usage, list_options); } + + strbuf_addstr(&hookname, argv[0]); head = hook_list(&hookname); @@ -41,10 +46,14 @@ static int list(int argc, const char **argv, const char *prefix) list_for_each(pos, head) { item = list_entry(pos, struct hook, list); - if (item) - printf("%s:\t%s\n", - config_scope_name(item->origin), - item->command.buf); + if (item) { + if (porcelain) + printf("%s\n", item->command.buf); + else + printf("%s:\t%s\n", + config_scope_name(item->origin), + item->command.buf); + } } clear_hook_list(); diff --git a/t/t1360-config-based-hooks.sh b/t/t1360-config-based-hooks.sh index 4e46d7dd4e..3296d8af45 100755 --- a/t/t1360-config-based-hooks.sh +++ b/t/t1360-config-based-hooks.sh @@ -55,4 +55,15 @@ test_expect_success 'git hook list reorders on duplicate commands' ' test_cmp expected actual ' +test_expect_success 'git hook list --porcelain prints just the command' ' + cat >expected <<-\EOF && + /path/ghi + /path/abc + /path/def + EOF + + git hook list --porcelain pre-commit >actual && + test_cmp expected actual +' + test_done
Teach 'git hook list --porcelain <hookname>', which prints simply the commands to be run in the order suggested by the config. This option is intended for use by user scripts, wrappers, or out-of-process Git commands which still want to execute hooks. For example, the following snippet might be added to git-send-email.perl to introduce a `pre-send-email` hook: sub pre_send_email { open(my $fh, 'git hook list --porcelain pre-send-email |'); chomp(my @hooks = <$fh>); close($fh); foreach $hook (@hooks) { system $hook } Signed-off-by: Emily Shaffer <emilyshaffer@google.com> --- Documentation/git-hook.txt | 13 +++++++++++-- builtin/hook.c | 17 +++++++++++++---- t/t1360-config-based-hooks.sh | 11 +++++++++++ 3 files changed, 35 insertions(+), 6 deletions(-)