26149bd83d
Right now, our doc generation scripts notice if you make changes and don't regen docs, don't include new docs, etc. But they miss it if your changes should have REMOVED a doc. Both kubectl-apiversion and kubectl-clusterinfo should have been removed, but weren't. This patch starts tracking all generated doc files and will cause problems if files should be removed and aren't.
87 lines
2.4 KiB
Bash
Executable File
87 lines
2.4 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Copyright 2014 Google Inc. 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
|
|
"${KUBE_ROOT}/hack/build-go.sh" cmd/gendocs cmd/genman cmd/genbashcomp
|
|
|
|
# Get the absolute path of the directory component of a file, i.e. the
|
|
# absolute path of the dirname of $1.
|
|
get_absolute_dirname() {
|
|
echo "$(cd "$(dirname "$1")" && pwd)"
|
|
}
|
|
|
|
gendocs=$(kube::util::find-binary "gendocs")
|
|
genman=$(kube::util::find-binary "genman")
|
|
genbashcomp=$(kube::util::find-binary "genbashcomp")
|
|
|
|
if [[ ! -x "$gendocs" || ! -x "$genman" || ! -x "$genbashcomp" ]]; then
|
|
{
|
|
echo "It looks as if you don't have a compiled gendocs, genman, or genbashcomp binary"
|
|
echo
|
|
echo "If you are running from a clone of the git repo, please run"
|
|
echo "'./hack/build-go.sh cmd/gendocs cmd/genman cmd/genbashcomp'."
|
|
} >&2
|
|
exit 1
|
|
fi
|
|
|
|
DOCROOT="${KUBE_ROOT}/docs/"
|
|
TMP_DOCROOT="${KUBE_ROOT}/docs_tmp/"
|
|
|
|
cp -a "${DOCROOT}" "${TMP_DOCROOT}"
|
|
|
|
kube::util::gen-doc "${genman}" "${TMP_DOCROOT}/man/man1/"
|
|
kube::util::gen-doc "${gendocs}" "${TMP_DOCROOT}"
|
|
|
|
echo "diffing ${DOCROOT} against freshly generated docs"
|
|
set +e
|
|
diff -Naupr -I 'Auto generated by' "${DOCROOT}" "${TMP_DOCROOT}"
|
|
ret=$?
|
|
set -e
|
|
rm -rf "${TMP_DOCROOT}"
|
|
if [ $ret -eq 0 ]
|
|
then
|
|
echo "${DOCROOT} up to date."
|
|
else
|
|
echo "${DOCROOT} is out of date. Please run hack/run-gendocs.sh"
|
|
exit 1
|
|
fi
|
|
|
|
COMPROOT="${KUBE_ROOT}/contrib/completions"
|
|
TMP_COMPROOT="${KUBE_ROOT}/contrib/completions_tmp"
|
|
cp -a "${COMPROOT}" "${TMP_COMPROOT}"
|
|
kube::util::gen-doc "${genbashcomp}" "${TMP_COMPROOT}/bash/"
|
|
set +e
|
|
diff -Naupr "${COMPROOT}" "${TMP_COMPROOT}"
|
|
ret=$?
|
|
set -e
|
|
rm -rf ${TMP_COMPROOT}
|
|
if [ $ret -eq 0 ]
|
|
then
|
|
echo "${COMPROOT} up to date."
|
|
else
|
|
echo "${COMPROOT} is out of date. Please run hack/run-gendocs.sh"
|
|
exit 1
|
|
fi
|
|
|
|
# ex: ts=2 sw=2 et filetype=sh
|