summaryrefslogtreecommitdiff
path: root/.git-hooks/commit-msg
blob: fa0b2e20aea81bb7b282bbe83f8159641657e1b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
#!/bin/sh
#
# An example hook script to check the commit log message.
# Called by git-commit with one argument, the name of the file
# that has the commit message.  The hook should exit with non-zero
# status after issuing an appropriate message if it wants to stop the
# commit.  The hook is allowed to edit the commit message file.
#
# To enable this hook, make this file executable.

# Uncomment the below to add a Signed-off-by line to the message.
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

# This example catches duplicate Signed-off-by lines.

base_dir=$(dirname $0)
MSG="$1"

abort() {
    cp $1 $1.save
    cat >&2 <<EOF
Commit aborted, your commit message was saved as '$1.save'.

Reason: $2

EOF
    exit 1
}

test "" = "$(grep '^Signed-off-by: ' "$1" |
	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
	abort "$1" "Duplicate Signed-off-by lines."
}

# Check that the first line exists, and is not an asterisk

if [ -z "`head -n 1 $1 | grep -v '^[ \t]*\*$'`" ] ; then
    abort "$1" "Please provide the general description on the first line."
fi

# ...and that it is not too long

if [ "`head -n 1 $1 | wc -c`" -gt 79 ] ; then
    abort "$1" "The first line is too long, please try to fit into 79 characters."
fi

# ...and that it does not continue on the second line
if [ "`wc -l < $1`" -gt 1 -a -n "`head -n 2 $1 | tail -n 1 | sed 's/^#.*//'`" ] ; then
    abort "$1" "The second line is not empty - maybe the first line continues there?"
fi

# Check that the message is not a ChangeLog-like one

if [ -n "`head -n 1 $1 | grep '^[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}.*<.*@.*>'`" ] ; then
    abort "$1" "The commit message looks like ChangeLog, please use the git form."
fi

# Check for whitespace in front of *'s

if [ -n "`sed '/^#/,$d' $1 | grep '^[[:space:]]\+\*.*:'`" -a -z "`grep '^\*' $1`" ] ; then
    abort "$1" "Please don't use whitespace in front of '* file: Description.' entries."
fi

#------------------ copied gerrit commit-msg hook to handle ChangeId -->
# From Gerrit Code Review 2.3
#
# Part of Gerrit Code Review (http://code.google.com/p/gerrit/)
#
# Copyright (C) 2009 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

CHANGE_ID_AFTER="Bug|Issue"

# Check for, and add if missing, a unique Change-Id
#
add_ChangeId() {
        clean_message=`sed -e '
                /^diff --git a\/.*/{
                        s///
                        q
                }
                /^Signed-off-by:/d
                /^#/d
        ' "$MSG" | git stripspace`
        if test -z "$clean_message"
        then
                return
        fi

        id=`grep -i '^Change-Id:' "$MSG" | sed -e "s/.*: I//"`
        temp_msg=`grep -v -i '^Change-Id:' "$MSG"`
        echo "$temp_msg" > "$MSG"

        if  test -z "$id"
        then
            id=`_gen_ChangeId`
        fi
        perl -e '
                $MSG = shift;
                $id = shift;
                $CHANGE_ID_AFTER = shift;

                undef $/;
                open(I, $MSG); $_ = <I>; close I;
                s|^diff --git a/.*||ms;
                s|^#.*$||mg;
                exit unless $_;

                @message = split /\n/;
                $haveFooter = 0;
                $startFooter = @message;
                for($line = @message - 1; $line >= 0; $line--) {
                        $_ = $message[$line];

                        if (/^[a-zA-Z0-9-]+: /) {
                                $haveFooter++;
                                next;
                        }
                        next if /^[ []/;
                        $startFooter = $line if ($haveFooter && /^\r?$/);
                        last;
                }

                @footer = @message[$startFooter+1..@message];
                @message = @message[0..$startFooter];
                push(@footer, "") unless @footer;

                for ($line = 0; $line < @footer; $line++) {
                        $_ = $footer[$line];
                        next if /^($CHANGE_ID_AFTER):/i;
                        last;
                }
                splice(@footer, $line, 0, "Change-Id: I$id");

                $_ = join("\n", @message, @footer);
                open(O, ">$MSG"); print O; close O;
        ' "$MSG" "$id" "$CHANGE_ID_AFTER"
}
_gen_ChangeIdInput() {
        echo "tree `git write-tree`"
        if parent=`git rev-parse HEAD^0 2>/dev/null`
        then
                echo "parent $parent"
        fi
        echo "author `git var GIT_AUTHOR_IDENT`"
        echo "committer `git var GIT_COMMITTER_IDENT`"
        echo
        printf '%s' "$clean_message"
}
_gen_ChangeId() {
        _gen_ChangeIdInput |
        git hash-object -t commit --stdin
}


add_ChangeId
#------------------ copied gerrit commit-msg hook to handle ChangeId <--


exit 0