From: Josh Steadmon <steadmon@google.com> To: git@vger.kernel.org Cc: gitster@pobox.com, git@grubix.eu, martin.agren@gmail.com Subject: [PATCH v3 3/4] git-merge: honor pre-merge-commit hook Date: Thu, 1 Aug 2019 15:20:45 -0700 Message-ID: <61b989ff16eadfd0508e10f71c9b318eb15ce2a7.1564695893.git.steadmon@google.com> (raw) In-Reply-To: <cover.1564695892.git.steadmon@google.com> git-merge does not honor the pre-commit hook when doing automatic merge commits, and for compatibility reasons this is going to stay. Introduce a pre-merge-commit hook which is called for an automatic merge commit just like pre-commit is called for a non-automatic merge commit (or any other commit). [js: * renamed hook from "pre-merge" to "pre-merge-commit" * only discard the index if the hook is actually present * clarified that hook should write messages to stderr * squashed test changes from the original series' patch 4/4 * modified tests to follow new pattern from this series' patch 1/4 * reworded commit message ] Signed-off-by: Michael J Gruber <git@grubix.eu> Signed-off-by: Josh Steadmon <steadmon@google.com> --- Documentation/githooks.txt | 7 +++ builtin/merge.c | 12 +++++ ...-pre-commit-and-pre-merge-commit-hooks.sh} | 45 ++++++++++++++++++- templates/hooks--pre-merge-commit.sample | 13 ++++++ 4 files changed, 76 insertions(+), 1 deletion(-) rename t/{t7503-pre-commit-hook.sh => t7503-pre-commit-and-pre-merge-commit-hooks.sh} (78%) create mode 100755 templates/hooks--pre-merge-commit.sample diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 82cd573776..7c4c994858 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -103,6 +103,13 @@ The default 'pre-commit' hook, when enabled--and with the `hooks.allownonascii` config option unset or set to false--prevents the use of non-ASCII filenames. +pre-merge-commit +~~~~~~~~~~~~~~~~ + +This hook is invoked by 'git merge' when doing an automatic merge +commit; it is equivalent to 'pre-commit' for a non-automatic commit +for a merge. + prepare-commit-msg ~~~~~~~~~~~~~~~~~~ diff --git a/builtin/merge.c b/builtin/merge.c index 4425a7a12e..bf0ae68c40 100644 --- a/builtin/merge.c +++ b/builtin/merge.c @@ -816,6 +816,18 @@ static void write_merge_heads(struct commit_list *); static void prepare_to_commit(struct commit_list *remoteheads) { struct strbuf msg = STRBUF_INIT; + const char *index_file = get_index_file(); + + if (run_commit_hook(0 < option_edit, index_file, "pre-merge-commit", NULL)) + abort_commit(remoteheads, NULL); + /* + * Re-read the index as pre-merge-commit hook could have updated it, + * and write it out as a tree. We must do this before we invoke + * the editor and after we invoke run_status above. + */ + if (find_hook("pre-merge-commit")) + discard_cache(); + read_cache_from(index_file); strbuf_addbuf(&msg, &merge_msg); if (squash) BUG("the control must not reach here under --squash"); diff --git a/t/t7503-pre-commit-hook.sh b/t/t7503-pre-commit-and-pre-merge-commit-hooks.sh similarity index 78% rename from t/t7503-pre-commit-hook.sh rename to t/t7503-pre-commit-and-pre-merge-commit-hooks.sh index 500bdd97c2..040dfa0175 100755 --- a/t/t7503-pre-commit-hook.sh +++ b/t/t7503-pre-commit-and-pre-merge-commit-hooks.sh @@ -1,11 +1,12 @@ #!/bin/sh -test_description='pre-commit hook' +test_description='pre-commit and pre-merge-commit hooks' . ./test-lib.sh HOOKDIR="$(git rev-parse --git-dir)/hooks" PRECOMMIT="$HOOKDIR/pre-commit" +PREMERGE="$HOOKDIR/pre-merge-commit" # Prepare sample scripts that write their $0 to actual_hooks test_expect_success 'sample script setup' ' @@ -29,6 +30,17 @@ test_expect_success 'sample script setup' ' EOF ' +test_expect_success 'root commit' ' + echo "root" > file && + git add file && + git commit -m "zeroth" && + git checkout -b side && + echo "foo" > foo && + git add foo && + git commit -m "make it non-ff" && + git checkout master +' + test_expect_success 'with no hook' ' test_when_finished "rm -f expected_hooks actual_hooks" && touch expected_hooks actual_hooks && @@ -38,6 +50,15 @@ test_expect_success 'with no hook' ' test_cmp expected_hooks actual_hooks ' +test_expect_success 'with no hook (merge)' ' + test_when_finished "rm -f expected_hooks actual_hooks" && + touch expected_hooks actual_hooks && + git checkout side && + git merge -m "merge master" master && + git checkout master && + test_cmp expected_hooks actual_hooks +' + test_expect_success '--no-verify with no hook' ' test_when_finished "rm -f expected_hooks actual_hooks" && touch expected_hooks actual_hooks && @@ -58,6 +79,17 @@ test_expect_success 'with succeeding hook' ' test_cmp expected_hooks actual_hooks ' +test_expect_success 'with succeeding hook (merge)' ' + test_when_finished "rm -f \"$PREMERGE\" expected_hooks actual_hooks" && + ln -s "success.sample" "$PREMERGE" && + touch actual_hooks && + echo "$PREMERGE" >expected_hooks && + git checkout side && + git merge -m "merge master" master && + git checkout master && + test_cmp expected_hooks actual_hooks +' + test_expect_success '--no-verify with succeeding hook' ' test_when_finished "rm -f \"$PRECOMMIT\" expected_hooks actual_hooks" && ln -s "success.sample" "$PRECOMMIT" && @@ -89,6 +121,17 @@ test_expect_success '--no-verify with failing hook' ' test_cmp expected_hooks actual_hooks ' +test_expect_success 'with failing hook (merge)' ' + test_when_finished "rm -f \"$PREMERGE\" expected_hooks actual_hooks" && + ln -s "fail.sample" "$PREMERGE" && + touch actual_hooks && + echo "$PREMERGE" >expected_hooks && + git checkout side && + test_must_fail git merge -m "merge master" master && + git checkout master && + test_cmp expected_hooks actual_hooks +' + test_expect_success POSIXPERM 'with non-executable hook' ' test_when_finished "rm -f \"$PRECOMMIT\" expected_hooks actual_hooks; chmod +x \"$HOOKDIR/fail.sample\"" && ln -s "fail.sample" "$PRECOMMIT" && diff --git a/templates/hooks--pre-merge-commit.sample b/templates/hooks--pre-merge-commit.sample new file mode 100755 index 0000000000..399eab1924 --- /dev/null +++ b/templates/hooks--pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: -- 2.22.0.770.g0f2c4a37fd-goog
next prev parent reply other threads:[~2019-08-01 22:20 UTC|newest] Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top 2017-09-22 12:04 [PATCH 0/4] pre-merge hook Michael J Gruber 2017-09-22 12:04 ` [PATCH 1/4] git-merge: Honor " Michael J Gruber 2017-09-22 19:52 ` Stefan Beller 2017-09-23 0:04 ` Martin Ågren 2017-09-22 12:04 ` [PATCH 2/4] merge: do no-verify like commit Michael J Gruber 2017-09-22 19:55 ` Stefan Beller 2017-09-22 12:04 ` [PATCH 3/4] merge: --no-verify to bypass pre-merge hook Michael J Gruber 2017-09-23 23:48 ` Junio C Hamano 2017-09-25 10:54 ` Michael J Gruber 2017-09-22 12:04 ` [PATCH 4/4] t7503: add tests for pre-merge-hook Michael J Gruber 2017-09-22 20:01 ` Stefan Beller 2017-10-02 5:54 ` [PATCH 0/4] pre-merge hook Junio C Hamano 2017-10-02 16:59 ` Stefan Beller 2017-10-17 4:05 ` Junio C Hamano 2019-07-18 22:57 ` [PATCH v2 " Josh Steadmon 2019-07-18 23:56 ` Josh Steadmon 2019-07-18 22:57 ` [PATCH v2 1/4] git-merge: Honor " Josh Steadmon 2019-07-29 20:00 ` Martin Ågren 2019-07-18 22:57 ` [PATCH v2 2/4] merge: do no-verify like commit Josh Steadmon 2019-07-18 22:57 ` [PATCH v2 3/4] merge: --no-verify to bypass pre-merge hook Josh Steadmon 2019-07-29 20:02 ` Martin Ågren 2019-07-29 23:33 ` Josh Steadmon 2019-07-18 22:57 ` [PATCH v2 4/4] t7503: add tests for pre-merge-hook Josh Steadmon 2019-07-29 20:04 ` Martin Ågren 2019-07-29 23:43 ` Josh Steadmon 2019-07-30 7:13 ` Martin Ågren 2019-07-31 18:34 ` Josh Steadmon 2019-07-29 20:09 ` [PATCH v2 0/4] pre-merge hook Martin Ågren 2019-07-29 23:29 ` Josh Steadmon 2019-07-29 20:29 ` Martin Ågren 2019-07-29 23:39 ` Josh Steadmon 2019-08-01 22:20 ` [PATCH v3 0/4] pre-merge-commit hook Josh Steadmon 2019-08-01 22:20 ` [PATCH v3 1/4] t7503: verify proper hook execution Josh Steadmon 2019-08-02 9:43 ` Martin Ågren 2019-08-01 22:20 ` [PATCH v3 2/4] merge: do no-verify like commit Josh Steadmon 2019-08-01 22:20 ` Josh Steadmon [this message] 2019-08-02 9:45 ` [PATCH v3 3/4] git-merge: honor pre-merge-commit hook Martin Ågren 2019-08-02 22:20 ` Josh Steadmon 2019-08-01 22:20 ` [PATCH v3 4/4] merge: --no-verify to bypass " Josh Steadmon 2019-08-02 9:56 ` [PATCH v3 0/4] " Martin Ågren 2019-08-02 9:56 ` [PATCH 1/5] t7503: use "&&" in "test_when_finished" rather than ";" Martin Ågren 2019-08-02 9:56 ` [PATCH 2/5] t7503: avoid touch when mtime doesn't matter Martin Ågren 2019-08-02 9:56 ` [PATCH 3/5] t7503: simplify file-juggling Martin Ågren 2019-08-02 9:56 ` [PATCH 4/5] t7503: don't create "actual_hooks" for later appending Martin Ågren 2019-08-02 9:56 ` [PATCH 5/5] t7503: test failing merge with both hooks available Martin Ågren 2019-08-02 22:18 ` [PATCH v3 0/4] pre-merge-commit hook Josh Steadmon 2019-08-05 22:43 ` [PATCH v4 " Josh Steadmon 2019-08-05 22:43 ` [PATCH v4 1/4] t7503: verify proper hook execution Josh Steadmon 2019-08-06 18:14 ` Junio C Hamano 2019-08-07 18:11 ` Josh Steadmon 2019-08-05 22:43 ` [PATCH v4 2/4] merge: do no-verify like commit Josh Steadmon 2019-08-05 22:43 ` [PATCH v4 3/4] git-merge: honor pre-merge-commit hook Josh Steadmon 2019-08-05 22:43 ` [PATCH v4 4/4] merge: --no-verify to bypass " Josh Steadmon 2019-08-07 18:57 ` [PATCH v5 0/4] " Josh Steadmon 2019-08-07 18:57 ` [PATCH v5 1/4] t7503: verify proper hook execution Josh Steadmon 2019-08-07 18:57 ` [PATCH v5 2/4] merge: do no-verify like commit Josh Steadmon 2019-08-07 18:57 ` [PATCH v5 3/4] git-merge: honor pre-merge-commit hook Josh Steadmon 2019-08-07 18:57 ` [PATCH v5 4/4] merge: --no-verify to bypass " Josh Steadmon 2019-08-08 13:08 ` [PATCH v5 0/4] " Martin Ågren
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 List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=61b989ff16eadfd0508e10f71c9b318eb15ce2a7.1564695893.git.steadmon@google.com \ --to=steadmon@google.com \ --cc=git@grubix.eu \ --cc=git@vger.kernel.org \ --cc=gitster@pobox.com \ --cc=martin.agren@gmail.com \ /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
git@vger.kernel.org list mirror (unofficial, one of many) This inbox may be cloned and mirrored by anyone: git clone --mirror https://public-inbox.org/git git clone --mirror http://ou63pmih66umazou.onion/git git clone --mirror http://czquwvybam4bgbro.onion/git git clone --mirror http://hjrcffqmbrq6wope.onion/git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V1 git git/ https://public-inbox.org/git \ git@vger.kernel.org public-inbox-index git Example config snippet for mirrors. Newsgroups are available over NNTP: nntp://news.public-inbox.org/inbox.comp.version-control.git nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git nntp://news.gmane.io/gmane.comp.version-control.git note: .onion URLs require Tor: https://www.torproject.org/ code repositories for the project(s) associated with this inbox: https://80x24.org/mirrors/git.git AGPL code for this site: git clone https://public-inbox.org/public-inbox.git