github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-12 20:57:20 +00:00
Code Issues Projects Releases Wiki Activity

Add API documentation pre-commit hook.

Browse Source
This commit is contained in:
Brian Grant
2014-11-20 00:05:55 +00:00
parent 57ec3a720b
commit 2ac8400cb2
4 changed files with 111 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
hooks/prepare-commit-msg
View File

@@ -2,37 +2,48 @@
KUBE_HOOKS_DIR="$(dirname "$(test -L "$0" && echo "$(dirname $0)/$(readlink "$0")" || echo "$0")")"
files_need_gofmt=""
files_need_boilerplate=""
files_need_gofmt=()
files_need_boilerplate=()
files_need_description=()
for file in $(git diff --cached --name-only --diff-filter ACM | grep "\.go" | grep -v -e "third_party" -e "Godeps"); do
# Check for files that fail gofmt.
diff="$(git show ":${file}" | gofmt -s -d)"
if [[ -n "$diff" ]]; then
files_need_gofmt="${files_need_gofmt} ${file}"
files_need_gofmt+=("${file}")
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
files_need_boilerplate="${files_need_boilerplate} ${file}"
files_need_boilerplate+=("${file}")
fi
done
# Check sh files for boilerplate
for file in $(git diff --cached --name-only --diff-filter ACM | grep "\.sh" | grep -v "third_party"); do
# 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
files_need_boilerplate="${files_need_boilerplate} ${file}"
files_need_boilerplate+=("${file}")
fi
done
if [[ -n "${files_need_gofmt}" ]]; then
# Check API schema definitions for field descriptions
# TODO: Check v1beta3, once it is documented
for file in $(git diff --cached --name-only --diff-filter ACM | egrep "pkg/api/v.[^/]*/types\.go" | grep -v "third_party" | grep -v v1beta3); do
# Check for files with fields without description tags
descriptionless=$("${KUBE_HOOKS_DIR}/description.sh" "${file}")
if [[ "$descriptionless" -eq "0" ]]; then
files_need_description+=("${file}")
fi
done
if [[ "${#files_need_gofmt[@]}" -ne 0 ]]; then
(
echo
echo "# *** ERROR: *** Some files have not been gofmt'd. To fix these"
echo "# errors, run gofmt -s -w <file>, or cut and paste the following:"
echo "# gofmt -s -w ${files_need_gofmt}"
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:"
@@ -40,12 +51,12 @@ if [[ -n "${files_need_gofmt}" ]]; then
) >> $1
fi
if [[ -n "${files_need_boilerplate}" ]]; then
if [[ "${#files_need_boilerplate[@]}" -ne 0 ]]; then
(
echo
echo "# *** ERROR: *** Some files are missing the required boilerplate"
echo "# header from hooks/boilerplate.txt:"
for file in ${files_need_boilerplate}; do
for file in "${files_need_boilerplate[@]}"; do
echo "# ${file}"
done
echo "#"
@@ -54,3 +65,18 @@ if [[ -n "${files_need_boilerplate}" ]]; then
echo
) >> $1
fi
if [[ "${#files_need_description[@]}" -ne 0 ]]; then
(
echo
echo "# *** ERROR: *** Some API files are missing the required field descriptions"
echo "# Add description tags to all non-inline fields in the following files:"
for file in "${files_need_description[@]}"; do
echo "# ${file}"
done
echo "#"
echo "# Your commit will be aborted unless you fix these."
echo "# COMMIT_BLOCKED_ON_DESCRIPTION"
echo
) >> $1
fi