github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-03 01:06:27 +00:00
Code Issues Projects Releases Wiki Activity

Slightly friendlier pre-commit errors.

Browse Source 
Make the pre-commit check spit out cut-and-paste commands and be more
obvious about errors.  Tested by making an invalid change and observing the
message generated.
This commit is contained in:
Tim Hockin 2014-06-24 15:01:08 -07:00
parent 7622bb871b
commit b6d5faf276
2 changed files with 35 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hooks/commit-msg
View File

@ -1,7 +1,7 @@
#!/bin/bash #!/bin/bash
if [[ "$(grep -c "# then delete this line" $1)" == "1" ]]; then if [[ "$(grep -c "COMMIT_BLOCKED" $1)" -gt 0 ]]; then
echo "Unresolved gofmt errors. Aborting commit." echo "FAILED: Unresolved errors - aborting the commit."
echo "The message of your attempted commit was:" echo "The message of your attempted commit was:"
cat $1 cat $1
exit 1 exit 1

43
hooks/prepare-commit-msg
View File

@ -2,23 +2,46 @@
KUBE_HOOKS_DIR="$(dirname "$(test -L "$0" && echo "$(dirname $0)/$(readlink "$0")" || echo "$0")")" KUBE_HOOKS_DIR="$(dirname "$(test -L "$0" && echo "$(dirname $0)/$(readlink "$0")" || echo "$0")")"
errors=0 files_need_gofmt=""
files_need_boilerplate=""
for file in $(git diff --cached --name-only --diff-filter ACM | grep "\.go" | grep -v "third_party"); do for file in $(git diff --cached --name-only --diff-filter ACM | grep "\.go" | grep -v "third_party"); do
# Check for files that fail gofmt.
diff="$(git show ":${file}" | gofmt -s -d)" diff="$(git show ":${file}" | gofmt -s -d)"
if [[ -n "$diff" ]]; then if [[ -n "$diff" ]]; then
echo "# *** ERROR: *** File ${file} has not been gofmt'd." >> $1 files_need_gofmt="${files_need_gofmt} ${file}"
errors=1
fi fi
# Check for files without the required boilerplate.
boilerplate="$(${KUBE_HOOKS_DIR}/boilerplate.sh ${file})" boilerplate="$(${KUBE_HOOKS_DIR}/boilerplate.sh ${file})"
if [[ "$boilerplate" -eq "0" ]]; then if [[ "$boilerplate" -eq "0" ]]; then
echo "# *** ERROR: *** File ${file} needs the boilerplate header in hooks/boilerplate.txt." >> $1 files_need_boilerplate="${files_need_boilerplate} ${file}"
errors=1
fi fi
done done
if [[ $errors == "1" ]]; then if [[ -n "${files_need_gofmt}" ]]; then
echo "# To fix these errors, run gofmt -s -w <file>." >> $1 (
echo "# If you want to commit in spite of these format errors," >> $1 echo
echo "# then delete this line. Otherwise, your commit will be" >> $1 echo "# *** ERROR: *** Some files have not been gofmt'd. To fix these"
echo "# aborted." >> $1 echo "# errors, run gofmt -s -w <file>, or cut and paste the following:"
echo "# gofmt -s -w ${files_need_gofmt}"
echo "#"
echo "# Your commit will be aborted unless you override this warning. To"
echo "# commit in spite of these format errors, delete the following line:"
echo "# COMMIT_BLOCKED_ON_GOFMT"
) >> $1
fi
if [[ -n "${files_need_boilerplate}" ]]; then
(
echo
echo "# *** ERROR: *** Some files are missing the required boilerplate"
echo "# header from hooks/boilerplate.txt:"
for file in ${files_need_boilerplate}; do
echo "# ${file}"
done
echo "#"
echo "# Your commit will be aborted unless you fix these."
echo "# COMMIT_BLOCKED_ON_BOILERPLATE"
echo
) >> $1
fi fi