check_format: Make CHANGELOG.md update recommendations
Notify users if they should consider updating CHANGELOG.md based on whether a file defining a public interface was modified. These are recommendations and are not fatal. Change-Id: I66d770917d86217325727411b292dad0582ed4e7 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/372560 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
parent
7571c2bb0c
commit
f5a4b0494c
@ -91,4 +91,41 @@ if hash pep8; then
|
||||
rm -f pep8.log
|
||||
fi
|
||||
|
||||
# Check if any of the public interfaces were modified by this patch.
|
||||
# Warn the user to consider updating the changelog any changes
|
||||
# are detected.
|
||||
echo -n "Checking whether CHANGELOG.md should be updated..."
|
||||
staged=$(git diff --name-only --cached .)
|
||||
working=$(git status -s --porcelain | grep -iv "??" | awk '{print $2}')
|
||||
files="$staged $working"
|
||||
if [[ "$files" = " " ]]; then
|
||||
files=$(git diff-tree --no-commit-id --name-only -r HEAD)
|
||||
fi
|
||||
|
||||
has_changelog=0
|
||||
for f in $files; do
|
||||
if [[ $f == CHANGELOG.md ]]; then
|
||||
# The user has a changelog entry, so exit.
|
||||
has_changelog=1
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
needs_changelog=0
|
||||
if [ $has_changelog -eq 0 ]; then
|
||||
for f in $files; do
|
||||
if [[ $f == include/spdk/* ]] || [[ $f == scripts/rpc.py ]] || [[ $f == etc/* ]]; then
|
||||
echo ""
|
||||
echo -n "$f was modified. Consider updating CHANGELOG.md."
|
||||
needs_changelog=1
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
if [ $needs_changelog -eq 0 ]; then
|
||||
echo " OK"
|
||||
else
|
||||
echo ""
|
||||
fi
|
||||
|
||||
exit $rc
|
||||
|
Loading…
x
Reference in New Issue
Block a user