Add sample pre-push hook script
Create a sample of a script for a pre-push hook. The main purpose is to illustrate how a script may parse the information which is supplied to such a hook. The script may also be useful to some people as-is for avoiding to push commits which are marked as a work in progress. Signed-off-by: Aaron Schrab <aaron@schrab.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Aaron Schrab committed
Jan 13, 2013 at 00:17 UTC
87c86dd14abe8db7d00b0df5661ef8cf147a72a3
1 file changed
+53
templates/hooks--pre-push.sample
new
+53
@@ -0,0 +1,53 @@
1
+#!/bin/sh
2
+
3
+# An example hook script to verify what is about to be pushed. Called by "git
4
+# push" after it has checked the remote status, but before anything has been
5
+# pushed. If this script exits with a non-zero status nothing will be pushed.
6
+#
7
+# This hook is called with the following parameters:
8
+#
9
+# $1 -- Name of the remote to which the push is being done
10
+# $2 -- URL to which the push is being done
11
+#
12
+# If pushing without using a named remote those arguments will be equal.
13
+#
14
+# Information about the commits which are being pushed is supplied as lines to
15
+# the standard input in the form:
16
+#
17
+# <local ref> <local sha1> <remote ref> <remote sha1>
18
+#
19
+# This sample shows how to prevent push of commits where the log message starts
20
+# with "WIP" (work in progress).
21
+
22
+remote="$1"
23
+url="$2"
24
+
25
+z40=0000000000000000000000000000000000000000
26
+
27
+IFS=' '
28
+while read local_ref local_sha remote_ref remote_sha
29
+do
30
+ if [ "$local_sha" = $z40 ]
31
+ then
32
+ # Handle delete
33
+ else
34
+ if [ "$remote_sha" = $z40 ]
35
+ then
36
+ # New branch, examine all commits
37
+ range="$local_sha"
38
+ else
39
+ # Update to existing branch, examine new commits
40
+ range="$remote_sha..$local_sha"
41
+ fi
42
+
43
+ # Check for WIP commit
44
+ commit=`git rev-list -n 1 --grep '^WIP' "$range"`
45
+ if [ -n "$commit" ]
46
+ then
47
+ echo "Found WIP commit in $local_ref, not pushing"
48
+ exit 1
49
+ fi
50
+ fi
51
+done
52
+
53
+exit 0