github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-21 19:01:49 +00:00
Code Issues Projects Releases Wiki Activity

Make description checker check for descriptions in internal API

Browse Source
This commit is contained in:
Paul Morie 2015-08-20 15:55:05 -04:00
parent 85ee11afc0
commit 2dceb28444
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
hack/verify-description.sh
View File

@ -38,18 +38,24 @@ find_files() {
}
if [[ $# -eq 0 ]]; then
files=`find_files | egrep "pkg/api/v.[^/]*/types\.go"`
versioned_api_files=`find_files | egrep "pkg/api/v.[^/]*/types\.go"`
else
files=("${@}")
versioned_api_files=("${@}")
fi
for file in $files; do
for file in $versioned_api_files; do
if grep json: "${file}" | grep -v // | grep -v ,inline | grep -v -q description: ; then
echo "API file is missing the required field descriptions: ${file}"
result=1
fi
done
internal_types_file="${KUBE_ROOT}/pkg/api/types.go"
if grep json: "${internal_types_file}" | grep -v // | grep description: ; then
echo "Internal API types should not contain descriptions"
result=1
fi
exit ${result}
# ex: ts=2 sw=2 et filetype=sh