From 2dceb2844413c4b8fadb5d2de33da6610516c95d Mon Sep 17 00:00:00 2001 From: Paul Morie Date: Thu, 20 Aug 2015 15:55:05 -0400 Subject: [PATCH] Make description checker check for descriptions in internal API --- hack/verify-description.sh | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/hack/verify-description.sh b/hack/verify-description.sh index 738034e48cd..2bb261305fe 100755 --- a/hack/verify-description.sh +++ b/hack/verify-description.sh @@ -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