mirror of
https://github.com/optim-enterprises-bv/kubernetes.git
synced 2025-11-04 04:08:16 +00:00
04e891c7d3
Also add a makefile. This will need a cherrypick onto 1.0,1.1 with edits to hack/jenkins/test-dockerized.sh to run branch-specific test scripts. Also had to modify hack/verify-api-reference.sh to handle volume mount path peculiarity when doing `docker run -v` inside a container started with `docker run -v`. See associated comment in hack/jenkins/test-dockerized.sh
56 lines
1.9 KiB
Bash
Executable File
56 lines
1.9 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Copyright 2015 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.
|
|
|
|
# Verifies that api reference docs are upto date.
|
|
|
|
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
|
|
|
|
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"
|
|
TMP_ROOT="${KUBE_ROOT}/_tmp"
|
|
|
|
# Generate API reference docs in tmp.
|
|
"./hack/update-api-reference-docs.sh" "${HOST_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}" "${TMP_OUTPUT_DIR}" || ret=$?
|
|
rm -rf "${TMP_ROOT}"
|
|
if [[ $ret -eq 0 ]]
|
|
then
|
|
echo "${API_REFERENCE_DOCS_ROOT} up to date."
|
|
else
|
|
echo "${API_REFERENCE_DOCS_ROOT} is out of date. Please run hack/update-api-reference-docs.sh"
|
|
exit 1
|
|
fi
|
|
|
|
# ex: ts=2 sw=2 et filetype=sh
|