mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
a36399ccfa
Add hooks branch for VTK-m so that developers can get some pre-commit checks easily. Commands used to setup GitSetup: git remote add -f setup https://robertmaynard@gitlab.kitware.com/utils/gitsetup.git git merge --no-commit --allow-unrelated-histories setup/hooks git read-tree -u --prefix=. setup/hooks
106 lines
3.0 KiB
Bash
Executable File
106 lines
3.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#=============================================================================
|
|
# Copyright 2010-2012 Kitware, Inc.
|
|
#
|
|
# 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.
|
|
#=============================================================================
|
|
|
|
. "${BASH_SOURCE%/*}/hooks-config.bash"
|
|
|
|
# Start with project-specific hook.
|
|
hooks_start commit-msg "$@"
|
|
|
|
# Prepare a copy of the message:
|
|
# - strip comment lines
|
|
# - stop at "diff --git" (git commit -v)
|
|
commit_msg="$GIT_DIR/COMMIT_MSG"
|
|
sed -n -e '/^#/d' -e '/^diff --git/q' -e 'p;d' "$1" > "$commit_msg"
|
|
|
|
die_advice='
|
|
To continue editing, run the command
|
|
git commit -e -F '"$commit_msg"'
|
|
(assuming your working directory is at the top).'
|
|
|
|
die() {
|
|
echo 'commit-msg hook failure' 1>&2
|
|
echo '-----------------------' 1>&2
|
|
echo '' 1>&2
|
|
echo "$@" 1>&2
|
|
test -n "$die_advice" && echo "$die_advice" 1>&2
|
|
exit 1
|
|
}
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Check the commit message layout with a simple state machine.
|
|
|
|
msg_is_merge() {
|
|
echo "$line" | grep "^Merge " >/dev/null 2>&1
|
|
}
|
|
|
|
msg_is_revert() {
|
|
echo "$line" | grep "^Revert " >/dev/null 2>&1
|
|
}
|
|
|
|
msg_first() {
|
|
len=$(echo -n "$line" | wc -c)
|
|
max_len=$(hooks_config --get hooks.commit-msg.maxLength || echo 78) &&
|
|
if test $len -eq 0; then
|
|
# not yet first line
|
|
return
|
|
elif test $len -lt 8; then
|
|
die 'The first line must be at least 8 characters:
|
|
--------
|
|
'"$line"'
|
|
--------'
|
|
elif test $len -gt "$max_len" && ! msg_is_merge && ! msg_is_revert; then
|
|
die 'The first line may be at most '"$max_len"' characters:
|
|
------------------------------------------------------------------------------
|
|
'"$line"'
|
|
------------------------------------------------------------------------------'
|
|
elif echo "$line" | grep "^[ ]\|[ ]$" >/dev/null 2>&1; then
|
|
die 'The first line may not have leading or trailing space:
|
|
['"$line"']'
|
|
else
|
|
# first line okay
|
|
state=second
|
|
fi
|
|
}
|
|
|
|
msg_second() {
|
|
if test "x$line" != "x"; then
|
|
die 'The second line must be empty:
|
|
'"$line"
|
|
else
|
|
state=rest
|
|
fi
|
|
}
|
|
|
|
msg_rest() {
|
|
if echo "$line" | grep -q "^Change-Id:"; then
|
|
die 'Gerrit Change-Id are not allowed in VTK-m.'
|
|
fi
|
|
}
|
|
|
|
# Pipe commit message into the state machine.
|
|
state=first
|
|
cat "$commit_msg" |
|
|
while IFS='' read line; do
|
|
msg_$state || break
|
|
done &&
|
|
rm -f "$commit_msg" || exit 1
|
|
die_advice='' # No more temporary message file.
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Chain to project-specific hook.
|
|
hooks_chain commit-msg "$@"
|