From 358221f9fdc4e534b8ef132b2faed1ab01305371 Mon Sep 17 00:00:00 2001 From: Chao Xu Date: Tue, 27 Oct 2015 13:57:42 -0700 Subject: [PATCH 1/3] Don't update api-reference docs if the only changes are the timestamps --- .../extensions/v1beta1/definitions.html | 0 .../extensions/v1beta1/operations.html | 0 docs/api-reference/v1/definitions.html | 0 docs/api-reference/v1/operations.html | 0 hack/gen-swagger-doc/Dockerfile | 5 ++ hack/gen-swagger-doc/gen-swagger-docs.sh | 2 +- hack/update-api-reference-docs.sh | 46 +++++++++++++++++-- 7 files changed, 48 insertions(+), 5 deletions(-) mode change 100644 => 100755 docs/api-reference/extensions/v1beta1/definitions.html mode change 100644 => 100755 docs/api-reference/extensions/v1beta1/operations.html mode change 100644 => 100755 docs/api-reference/v1/definitions.html mode change 100644 => 100755 docs/api-reference/v1/operations.html diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html old mode 100644 new mode 100755 diff --git a/docs/api-reference/extensions/v1beta1/operations.html b/docs/api-reference/extensions/v1beta1/operations.html old mode 100644 new mode 100755 diff --git a/docs/api-reference/v1/definitions.html b/docs/api-reference/v1/definitions.html old mode 100644 new mode 100755 diff --git a/docs/api-reference/v1/operations.html b/docs/api-reference/v1/operations.html old mode 100644 new mode 100755 diff --git a/hack/gen-swagger-doc/Dockerfile b/hack/gen-swagger-doc/Dockerfile index 27e2d3b9b13..9ad26afcc61 100644 --- a/hack/gen-swagger-doc/Dockerfile +++ b/hack/gen-swagger-doc/Dockerfile @@ -7,6 +7,9 @@ RUN wget https://services.gradle.org/distributions/gradle-2.5-bin.zip RUN mkdir build/ RUN unzip gradle-2.5-bin.zip -d build/ +RUN mkdir gradle-cache/ +ENV GRADLE_USER_HOME=/gradle-cache + COPY build.gradle build/ COPY gen-swagger-docs.sh build/ @@ -17,5 +20,7 @@ RUN wget https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/swag RUN build/gen-swagger-docs.sh v1 https://raw.githubusercontent.com/GoogleCloudPlatform/kubernetes/master/pkg/api/v1/register.go RUN rm /output/* RUN rm /swagger-source/* +RUN chmod -R 777 build/ +RUN chmod -R 777 gradle-cache/ ENTRYPOINT ["build/gen-swagger-docs.sh"] diff --git a/hack/gen-swagger-doc/gen-swagger-docs.sh b/hack/gen-swagger-doc/gen-swagger-docs.sh index 3ed3a9c0e33..91f39cf5a0a 100755 --- a/hack/gen-swagger-doc/gen-swagger-docs.sh +++ b/hack/gen-swagger-doc/gen-swagger-docs.sh @@ -20,7 +20,7 @@ set -o errexit set -o nounset set -o pipefail -cd /build/ +cd /build wget "$2" -O register.go diff --git a/hack/update-api-reference-docs.sh b/hack/update-api-reference-docs.sh index 8f5806c8740..0325ca74490 100755 --- a/hack/update-api-reference-docs.sh +++ b/hack/update-api-reference-docs.sh @@ -22,14 +22,24 @@ set -o nounset set -o pipefail KUBE_ROOT=$(dirname "${BASH_SOURCE}")/.. -REPO_DIR=${REPO_DIR:-"${PWD}/${KUBE_ROOT}"} +source "${KUBE_ROOT}/hack/lib/init.sh" +kube::golang::setup_env +kube::util::ensure-temp-dir + +#KUBE_ROOT should be an absolute path now that we have run kube::golang::setup_env. +REPO_DIR=${REPO_DIR:-"${KUBE_ROOT}"} DEFAULT_OUTPUT_PATH="${REPO_DIR}/docs/api-reference" OUTPUT=${1:-${DEFAULT_OUTPUT_PATH}} +OUTPUT_TEMP="${KUBE_TEMP}/generated_html" echo "Generating api reference docs at ${OUTPUT}" V1_PATH="${OUTPUT}/v1/" -V1BETA1_PATH="${OUTPUT}/extensions/v1beta1" +V1_TEMP_PATH="${OUTPUT_TEMP}/v1/" +mkdir -p ${V1_TEMP_PATH} +V1BETA1_PATH="${OUTPUT}/extensions/v1beta1/" +V1BETA1_TEMP_PATH="${OUTPUT_TEMP}/extensions/v1beta1/" +mkdir -p ${V1BETA1_TEMP_PATH} SWAGGER_PATH="${REPO_DIR}/api/swagger-spec/" echo "Reading swagger spec from: ${SWAGGER_PATH}" @@ -37,12 +47,40 @@ echo "Reading swagger spec from: ${SWAGGER_PATH}" mkdir -p $V1_PATH mkdir -p $V1BETA1_PATH -docker run --rm -v $V1_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v3 \ +docker run -u $(id -u) --rm -v $V1_TEMP_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \ v1 \ https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/api/v1/register.go -docker run --rm -v $V1BETA1_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v3 \ +docker run -u $(id -u) --rm -v $V1BETA1_TEMP_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \ v1beta1 \ https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/apis/extensions/v1beta1/register.go +# Check if we actually changed anything +pushd "${OUTPUT_TEMP}" > /dev/null +touch .generated_html +find . -type f | cut -sd / -f 2- | LC_ALL=C sort > .generated_html +popd > /dev/null + +while read file; do + if [[ -e "${OUTPUT}/${file}" && -e "${OUTPUT_TEMP}/${file}" ]]; then + echo "comparing ${OUTPUT}/${file} with ${OUTPUT_TEMP}/${file}" + # Filter all munges from original content. + original=$(cat "${OUTPUT}/${file}") + generated=$(cat "${OUTPUT_TEMP}/${file}") + + # Filter out meaningless lines with timestamps + original=$(echo "${original}" | grep -v "Last updated" || :) + generated=$(echo "${generated}" | grep -v "Last updated" || :) + + # By now, the contents should be normalized and stripped of any + # auto-managed content. + if diff -Bw >/dev/null <(echo "${original}") <(echo "${generated}"); then + # actual contents same, overwrite generated with original. + cp "${OUTPUT}/${file}" "${OUTPUT_TEMP}/${file}" + fi + fi +done <"${OUTPUT_TEMP}/.generated_html" + +cp -af "${OUTPUT_TEMP}"/* "${OUTPUT}" + # ex: ts=2 sw=2 et filetype=sh From 4e4c67c6243a07082d495b705342b6144a8ffc83 Mon Sep 17 00:00:00 2001 From: Chao Xu Date: Fri, 6 Nov 2015 16:58:15 -0800 Subject: [PATCH 2/3] address host dir vs docker dir issue --- hack/update-api-reference-docs.sh | 54 +++++++++++++++++-------------- hack/verify-api-reference-docs.sh | 13 ++------ 2 files changed, 33 insertions(+), 34 deletions(-) diff --git a/hack/update-api-reference-docs.sh b/hack/update-api-reference-docs.sh index 0325ca74490..0d811b64a25 100755 --- a/hack/update-api-reference-docs.sh +++ b/hack/update-api-reference-docs.sh @@ -24,49 +24,52 @@ set -o pipefail KUBE_ROOT=$(dirname "${BASH_SOURCE}")/.. source "${KUBE_ROOT}/hack/lib/init.sh" kube::golang::setup_env -kube::util::ensure-temp-dir -#KUBE_ROOT should be an absolute path now that we have run kube::golang::setup_env. +DEFAULT_OUTPUT="${KUBE_ROOT}/docs/api-reference" +OUTPUT=${1:-${DEFAULT_OUTPUT}} +# Use REPO_DIR if provided so we can set it to the host-resolvable path +# to the repo root if we are running this script from a container with +# docker mounted in as a volume. +# We pass the host output dir as the source dir to `docker run -v`, but use +# the regular one to compute diff (they will be the same if running this +# test on the host, potentially different if running in a container). REPO_DIR=${REPO_DIR:-"${KUBE_ROOT}"} -DEFAULT_OUTPUT_PATH="${REPO_DIR}/docs/api-reference" -OUTPUT=${1:-${DEFAULT_OUTPUT_PATH}} -OUTPUT_TEMP="${KUBE_TEMP}/generated_html" +TMP_SUBPATH="_output/generated_html" +OUTPUT_TMP_IN_HOST="${REPO_DIR}/${TMP_SUBPATH}" +OUTPUT_TMP="${KUBE_ROOT}/${TMP_SUBPATH}" -echo "Generating api reference docs at ${OUTPUT}" +echo "Generating api reference docs at ${OUTPUT_TMP}" -V1_PATH="${OUTPUT}/v1/" -V1_TEMP_PATH="${OUTPUT_TEMP}/v1/" -mkdir -p ${V1_TEMP_PATH} -V1BETA1_PATH="${OUTPUT}/extensions/v1beta1/" -V1BETA1_TEMP_PATH="${OUTPUT_TEMP}/extensions/v1beta1/" -mkdir -p ${V1BETA1_TEMP_PATH} +V1_TMP_IN_HOST="${OUTPUT_TMP_IN_HOST}/v1/" +V1_TMP="${OUTPUT_TMP}/v1/" +mkdir -p ${V1_TMP} +V1BETA1_TMP_IN_HOST="${OUTPUT_TMP_IN_HOST}/extensions/v1beta1/" +V1BETA1_TMP="${OUTPUT_TMP}/extensions/v1beta1/" +mkdir -p ${V1BETA1_TMP} SWAGGER_PATH="${REPO_DIR}/api/swagger-spec/" echo "Reading swagger spec from: ${SWAGGER_PATH}" -mkdir -p $V1_PATH -mkdir -p $V1BETA1_PATH - -docker run -u $(id -u) --rm -v $V1_TEMP_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \ +docker run -u $(id -u) --rm -v $V1_TMP_IN_HOST:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \ v1 \ https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/api/v1/register.go -docker run -u $(id -u) --rm -v $V1BETA1_TEMP_PATH:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \ +docker run -u $(id -u) --rm -v $V1BETA1_TMP_IN_HOST:/output:z -v ${SWAGGER_PATH}:/swagger-source:z gcr.io/google_containers/gen-swagger-docs:v4 \ v1beta1 \ https://raw.githubusercontent.com/kubernetes/kubernetes/master/pkg/apis/extensions/v1beta1/register.go # Check if we actually changed anything -pushd "${OUTPUT_TEMP}" > /dev/null +pushd "${OUTPUT_TMP}" > /dev/null touch .generated_html find . -type f | cut -sd / -f 2- | LC_ALL=C sort > .generated_html popd > /dev/null while read file; do - if [[ -e "${OUTPUT}/${file}" && -e "${OUTPUT_TEMP}/${file}" ]]; then - echo "comparing ${OUTPUT}/${file} with ${OUTPUT_TEMP}/${file}" + if [[ -e "${OUTPUT}/${file}" && -e "${OUTPUT_TMP}/${file}" ]]; then + echo "comparing ${OUTPUT}/${file} with ${OUTPUT_TMP}/${file}" # Filter all munges from original content. original=$(cat "${OUTPUT}/${file}") - generated=$(cat "${OUTPUT_TEMP}/${file}") + generated=$(cat "${OUTPUT_TMP}/${file}") # Filter out meaningless lines with timestamps original=$(echo "${original}" | grep -v "Last updated" || :) @@ -76,11 +79,14 @@ while read file; do # auto-managed content. if diff -Bw >/dev/null <(echo "${original}") <(echo "${generated}"); then # actual contents same, overwrite generated with original. - cp "${OUTPUT}/${file}" "${OUTPUT_TEMP}/${file}" + cp "${OUTPUT}/${file}" "${OUTPUT_TMP}/${file}" fi fi -done <"${OUTPUT_TEMP}/.generated_html" +done <"${OUTPUT_TMP}/.generated_html" -cp -af "${OUTPUT_TEMP}"/* "${OUTPUT}" +echo "Moving api reference docs from ${OUT_TMP} to ${OUTPUT}" + +cp -af "${OUTPUT_TMP}"/* "${OUTPUT}" +rm -r ${OUTPUT_TMP} # ex: ts=2 sw=2 et filetype=sh diff --git a/hack/verify-api-reference-docs.sh b/hack/verify-api-reference-docs.sh index f718836a4ad..79d86b6bc66 100755 --- a/hack/verify-api-reference-docs.sh +++ b/hack/verify-api-reference-docs.sh @@ -26,15 +26,8 @@ source "${KUBE_ROOT}/hack/lib/init.sh" kube::golang::setup_env API_REFERENCE_DOCS_ROOT="${KUBE_ROOT}/docs/api-reference" -# Use REPO_DIR if provided so we can set it to the host-resolvable path -# to the repo root if we are running this script from a container with -# docker mounted in as a volume. -# We pass the host output dir to update-api-reference-docs.sh, but use -# the regular one to compute diff (they will be the same if running this -# test on the host, potentially different if running in a container). -REPO_DIR=${REPO_DIR:-"${KUBE_ROOT}"} -HOST_OUTPUT_DIR="${REPO_DIR}/_tmp/api-reference" -TMP_OUTPUT_DIR="${KUBE_ROOT}/_tmp/api-reference" +HOST_OUTPUT_DIR="${KUBE_ROOT}/_tmp/api-reference" +mkdir -p ${HOST_OUTPUT_DIR} TMP_ROOT="${KUBE_ROOT}/_tmp" # Generate API reference docs in tmp. @@ -42,7 +35,7 @@ TMP_ROOT="${KUBE_ROOT}/_tmp" echo "diffing ${API_REFERENCE_DOCS_ROOT} against freshly generated docs" ret=0 -diff -Naupr -I 'Last update' --exclude=*.md "${API_REFERENCE_DOCS_ROOT}" "${TMP_OUTPUT_DIR}" || ret=$? +diff -Naupr -I 'Last update' --exclude=*.md "${API_REFERENCE_DOCS_ROOT}" "${HOST_OUTPUT_DIR}" || ret=$? rm -rf "${TMP_ROOT}" if [[ $ret -eq 0 ]] then From bd302d95343ef944a0a008daab6984c250e609ea Mon Sep 17 00:00:00 2001 From: Chao Xu Date: Fri, 6 Nov 2015 17:16:48 -0800 Subject: [PATCH 3/3] address comments and fix --- hack/update-api-reference-docs.sh | 2 +- hack/verify-api-reference-docs.sh | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/hack/update-api-reference-docs.sh b/hack/update-api-reference-docs.sh index 0d811b64a25..5753b98d11c 100755 --- a/hack/update-api-reference-docs.sh +++ b/hack/update-api-reference-docs.sh @@ -84,7 +84,7 @@ while read file; do fi done <"${OUTPUT_TMP}/.generated_html" -echo "Moving api reference docs from ${OUT_TMP} to ${OUTPUT}" +echo "Moving api reference docs from ${OUTPUT_TMP} to ${OUTPUT}" cp -af "${OUTPUT_TMP}"/* "${OUTPUT}" rm -r ${OUTPUT_TMP} diff --git a/hack/verify-api-reference-docs.sh b/hack/verify-api-reference-docs.sh index 79d86b6bc66..af93a63a4d4 100755 --- a/hack/verify-api-reference-docs.sh +++ b/hack/verify-api-reference-docs.sh @@ -26,16 +26,16 @@ source "${KUBE_ROOT}/hack/lib/init.sh" kube::golang::setup_env API_REFERENCE_DOCS_ROOT="${KUBE_ROOT}/docs/api-reference" -HOST_OUTPUT_DIR="${KUBE_ROOT}/_tmp/api-reference" -mkdir -p ${HOST_OUTPUT_DIR} +OUTPUT_DIR="${KUBE_ROOT}/_tmp/api-reference" +mkdir -p ${OUTPUT_DIR} TMP_ROOT="${KUBE_ROOT}/_tmp" # Generate API reference docs in tmp. -"./hack/update-api-reference-docs.sh" "${HOST_OUTPUT_DIR}" +"./hack/update-api-reference-docs.sh" "${OUTPUT_DIR}" echo "diffing ${API_REFERENCE_DOCS_ROOT} against freshly generated docs" ret=0 -diff -Naupr -I 'Last update' --exclude=*.md "${API_REFERENCE_DOCS_ROOT}" "${HOST_OUTPUT_DIR}" || ret=$? +diff -Naupr -I 'Last update' --exclude=*.md "${API_REFERENCE_DOCS_ROOT}" "${OUTPUT_DIR}" || ret=$? rm -rf "${TMP_ROOT}" if [[ $ret -eq 0 ]] then