4636af5b87
The standard Git convention is "origin", not "upstream", so make it flexible in the scripts for those who are set up differently.
83 lines
2.6 KiB
Bash
Executable File
83 lines
2.6 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Copyright 2014 The Kubernetes Authors All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/../..
|
|
source "${KUBE_ROOT}/hack/lib/init.sh"
|
|
|
|
kube::golang::setup_env
|
|
|
|
# Find binary
|
|
gendocs=$(kube::util::find-binary "gendocs")
|
|
genkubedocs=$(kube::util::find-binary "genkubedocs")
|
|
genman=$(kube::util::find-binary "genman")
|
|
genyaml=$(kube::util::find-binary "genyaml")
|
|
genbashcomp=$(kube::util::find-binary "genbashcomp")
|
|
mungedocs=$(kube::util::find-binary "mungedocs")
|
|
|
|
DOCROOT="${KUBE_ROOT}/docs/"
|
|
EXAMPLEROOT="${KUBE_ROOT}/examples/"
|
|
|
|
# mungedocs --verify can (and should) be run on the real docs, otherwise their
|
|
# links will be distorted. --verify means that it will not make changes.
|
|
# --verbose gives us output we can use for a diff.
|
|
"${mungedocs}" "--verify=true" "--verbose=true" "--upstream=${KUBE_GIT_UPSTREAM}" "--root-dir=${DOCROOT}" && ret=0 || ret=$?
|
|
if [[ $ret -eq 1 ]]; then
|
|
echo "${DOCROOT} is out of date. Please run hack/update-generated-docs.sh"
|
|
exit 1
|
|
fi
|
|
if [[ $ret -gt 1 ]]; then
|
|
echo "Error running mungedocs"
|
|
exit 1
|
|
fi
|
|
|
|
"${mungedocs}" "--verify=true" "--verbose=true" "--upstream=${KUBE_GIT_UPSTREAM}" "--root-dir=${EXAMPLEROOT}" && ret=0 || ret=$?
|
|
if [[ $ret -eq 1 ]]; then
|
|
echo "${EXAMPLEROOT} is out of date. Please run hack/update-generated-docs.sh"
|
|
exit 1
|
|
fi
|
|
if [[ $ret -gt 1 ]]; then
|
|
echo "Error running mungedocs"
|
|
exit 1
|
|
fi
|
|
|
|
|
|
kube::util::ensure-temp-dir
|
|
|
|
kube::util::gen-docs "${KUBE_TEMP}"
|
|
diff -Naup "${KUBE_TEMP}/.generated_docs" "${KUBE_ROOT}/.generated_docs" || ret=1 || true
|
|
while read file; do
|
|
diff -Naup "${KUBE_TEMP}/${file}" "${KUBE_ROOT}/${file}" || ret=1 || true
|
|
done <"${KUBE_TEMP}/.generated_docs"
|
|
|
|
needsanalytics=($(kube::util::gen-analytics "${KUBE_ROOT}" 1))
|
|
if [[ ${#needsanalytics[@]} -ne 0 ]]; then
|
|
echo -e "Some md files are missing ga-beacon analytics link:"
|
|
printf '%s\n' "${needsanalytics[@]}"
|
|
ret=1
|
|
fi
|
|
if [[ $ret -eq 0 ]]
|
|
then
|
|
echo "Generated docs are up to date."
|
|
else
|
|
echo "Generated docs are out of date. Please run hack/update-generated-docs.sh"
|
|
exit 1
|
|
fi
|
|
# ex: ts=2 sw=2 et filetype=sh
|