cert-manager/hack/verify-reference-docs.sh
James Munnelly f1b942e0af Improve update-reference-docs UX
Signed-off-by: James Munnelly <james@munnelly.eu>
2019-09-26 15:26:29 +01:00

59 lines
1.6 KiB
Bash
Executable File

#!/usr/bin/env bash
# Copyright 2019 The Jetstack cert-manager contributors.
#
# 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 nounset
set -o errexit
set -o pipefail
if [[ -n "${TEST_WORKSPACE:-}" ]]; then # Running inside bazel
echo "Checking generated API reference documentation for changes..." >&2
elif ! command -v bazel &>/dev/null; then
echo "Install bazel at https://bazel.build" >&2
exit 1
else
(
set -o xtrace
bazel test --test_output=streamed //hack:verify-reference-docs
)
exit 0
fi
compare_to=$(realpath "docs/generated/reference/output")
tmpfiles=$TEST_TMPDIR/files
(
mkdir -p "$tmpfiles"
rm -f bazel-*
cp -aL "." "$tmpfiles"
export BUILD_WORKSPACE_DIRECTORY=$tmpfiles
"$@"
)
# Avoid diff -N so we handle empty files correctly
diff=$(diff -upr \
-x ".git" \
-x "bazel-*" \
-x "_output" \
"." "$tmpfiles" 2>/dev/null || true)
if [[ -n "${diff}" ]]; then
echo "${diff}" >&2
echo >&2
echo "ERROR: generated API reference documentation changed. Update with ./hack/update-reference-docs.sh" >&2
exit 1
fi
echo "SUCCESS: generated API reference documentation up-to-date"