-
Notifications
You must be signed in to change notification settings - Fork 510
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
common: check commit msg format in pull requests
- Loading branch information
Showing
2 changed files
with
89 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
#!/bin/bash | ||
# | ||
# Copyright 2017, Intel Corporation | ||
# | ||
# Redistribution and use in source and binary forms, with or without | ||
# modification, are permitted provided that the following conditions | ||
# are met: | ||
# | ||
# * Redistributions of source code must retain the above copyright | ||
# notice, this list of conditions and the following disclaimer. | ||
# | ||
# * Redistributions in binary form must reproduce the above copyright | ||
# notice, this list of conditions and the following disclaimer in | ||
# the documentation and/or other materials provided with the | ||
# distribution. | ||
# | ||
# * Neither the name of the copyright holder nor the names of its | ||
# contributors may be used to endorse or promote products derived | ||
# from this software without specific prior written permission. | ||
# | ||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
# | ||
|
||
# | ||
# Used to check whether all the commit messages in a pull request | ||
# follow the GIT/NVML guidelines. | ||
# | ||
# usage: ./check-commit.sh | ||
# | ||
|
||
if [[ $TRAVIS_REPO_SLUG != "pmem/nvml" \ | ||
|| $TRAVIS_EVENT_TYPE != "pull_request" ]]; | ||
then | ||
echo "SKIP: $0 can only be executed for pull requests to pmem/nvml" | ||
exit 0 | ||
fi | ||
|
||
# Find all the commits for the current build | ||
if [[ -n "$TRAVIS_COMMIT_RANGE" ]]; then | ||
commits=$(git rev-list $TRAVIS_COMMIT_RANGE) | ||
else | ||
commits=$TRAVIS_COMMIT | ||
fi | ||
|
||
# valid area names | ||
AREAS="pmem\|rpmem\|log\|blk\|obj\|pool\|test\|benchmark\|examples\|vmem\|jemalloc\|cpp\|doc\|common" | ||
|
||
# Check for changes in the generated docs directory | ||
for commit in $commits; do | ||
subject=$(git log --format="%s" -n 1 $commit) | ||
body=$(git log --format="%b" -n 1 $commit) | ||
subject_len=$(echo $subject | wc -m) | ||
body_len=$(echo $body | wc -L) | ||
prefix=$(echo $subject | sed -e "s/^\($AREAS\)\:.*/\1/") | ||
|
||
if [[ $subject =~ ^Merge.* ]]; then | ||
# skip | ||
continue | ||
fi | ||
if [ "$prefix" = "" ]; then | ||
echo "FAIL: subject line in commit message does not contain valid area name" | ||
echo | ||
git log -n 1 $commit | ||
exit 1 | ||
fi | ||
if [ $subject_len -gt 51 ]; then | ||
echo "FAIL: subject line in commit message exceeds 50 chars ($subject_len)" | ||
echo | ||
git log -n 1 $commit | ||
exit 1 | ||
fi | ||
if [ $body_len -gt 73 ]; then | ||
echo "FAIL: commit message body exceeds 72 chars per line ($body_len)" | ||
echo | ||
git log -n 1 $commit | ||
exit 1 | ||
fi | ||
done |