.git-hooks/commit-msg

   1 #!/bin/sh
   2 #
   3 # Called by git-commit with one argument, the name of the file
   4 # that has the commit message.  The hook should exit with non-zero
   5 # status after issuing an appropriate message if it wants to stop the
   6 # commit.  The hook is allowed to edit the commit message file.
   7 #
   8 # To enable this hook, make this file executable.
   9
  10 # avoid [[ which is not POSIX sh.
  11
  12 if test "$#" != 1 ; then
  13     echo "$0 requires an argument."
  14     exit 1
  15 fi
  16
  17 if test ! -f "$1" ; then
  18     echo "file does not exist: $1"
  19     exit 1
  20 fi
  21
  22 abort() {
  23     cp $1 $1.save
  24     cat >&2 <<EOF
  25 Commit aborted, your commit message was saved as '$1.save'.
  26
  27 Reason: $2
  28
  29 EOF
  30     exit 1
  31 }
  32
  33 test "" = "$(grep '^Signed-off-by: ' "$1" |
  34          sort | uniq -c | sed -e '/^[         ]*1[         ]/d')" || {
  35     abort "$1" "Duplicate Signed-off-by lines."
  36 }
  37
  38 # Check that the first line exists, and is not an asterisk
  39
  40 if [ -z "`head -n 1 $1 | grep -v '^[[:blank:]]*\*$'`" ] ; then
  41     abort "$1" "Please provide the general description on the first line."
  42 fi
  43
  44 # ...and that it is not too long
  45
  46 len="`head -n 1 $1 | tr -d '\n' | wc -c`"
  47 if [ "$len" -gt 79 ] ; then
  48     abort "$1" "The first line is $len characters, please try to fit into 79 characters."
  49 fi
  50
  51 fdo_regex='fdo#[0-9]+'
  52 if grep -E -q "$fdo_regex" $1; then
  53     for bugid in `head -n 1 $1 | grep -E -o "$fdo_regex" |sed 's/fdo#//'`
  54     do
  55         if [ "`echo $bugid |sed 's/fdo#//'`" -gt 88775 ]; then
  56             abort "$1" "The first line contains a suspicious fdo# rereference: 'fdo#$bugid', did you mean tdf#?"
  57         fi
  58     done
  59 fi
  60
  61 # ...and that it does not continue on the second line
  62 if [ "`wc -l < $1`" -gt 1 -a -n "`head -n 2 $1 | tail -n 1 | sed 's/^#.*//'`" ] ; then
  63     abort "$1" "The second line is not empty - maybe the first line continues there?"
  64 fi
  65
  66 # Check that the message is not a ChangeLog-like one
  67
  68 if [ -n "`head -n 1 $1 | grep '^[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}.*<.*@.*>'`" ] ; then
  69     abort "$1" "The commit message looks like ChangeLog, please use the git form."
  70 fi
  71
  72 # Check that lines do not start with '#<something>' (possibly accidental commit,
  73 # such as starting the message with '#ifdef', git commits start with '#<whitespace>'.
  74
  75 if [ -n "`grep '^#[^[:blank:]]' $1`" ] ; then
  76     abort "$1" "Possible accidental comment in the commit message (leading # without space)."
  77 fi
  78
  79 # From Gerrit Code Review 2.16.15
  80 #
  81 # Part of Gerrit Code Review (https://www.gerritcodereview.com/)
  82 #
  83 # Copyright (C) 2009 The Android Open Source Project
  84 #
  85 # Licensed under the Apache License, Version 2.0 (the "License");
  86 # you may not use this file except in compliance with the License.
  87 # You may obtain a copy of the License at
  88 #
  89 # http://www.apache.org/licenses/LICENSE-2.0
  90 #
  91 # Unless required by applicable law or agreed to in writing, software
  92 # distributed under the License is distributed on an "AS IS" BASIS,
  93 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  94 # See the License for the specific language governing permissions and
  95 # limitations under the License.
  96
  97 # Do not create a change id if requested
  98 if test "false" = "`git config --bool --get gerrit.createChangeId`" ; then
  99     exit 0
 100 fi
 101
 102 # $RANDOM will be undefined if not using bash, so don't use set -u
 103 random=$( (whoami ; hostname ; date; cat $1 ; echo $RANDOM) | git hash-object --stdin)
 104 dest="$1.tmp.${random}"
 105
 106 trap 'rm -f "${dest}"' EXIT
 107
 108 if ! git stripspace --strip-comments < "$1" > "${dest}" ; then
 109     echo "cannot strip comments from $1"
 110     exit 1
 111 fi
 112
 113 if test ! -s "${dest}" ; then
 114     echo "file is empty: $1"
 115     exit 1
 116 fi
 117
 118 # Avoid the --in-place option which only appeared in Git 2.8
 119 # Avoid the --if-exists option which only appeared in Git 2.15
 120 if ! git -c trailer.ifexists=doNothing interpret-trailers \
 121         --trailer "Change-Id: I${random}" < "$1" > "${dest}" ; then
 122     echo "cannot insert change-id line in $1"
 123     exit 1
 124 fi
 125
 126 if ! mv "${dest}" "$1" ; then
 127     echo "cannot mv ${dest} to $1"
 128     exit 1
 129 fi
 130
 131 #------------------ copied gerrit commit-msg hook to handle ChangeId <--
 132
 133 exit 0
 134
 135 # vi:set shiftwidth=4 expandtab: