tidb-operator/hack/verify-api-references.sh

53 lines
1.5 KiB
Bash
Executable File

#!/usr/bin/env bash
# Copyright 2020 PingCAP, Inc.
#
# 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,
# See the License for the specific language governing permissions and
# limitations under the License.
set -o errexit
set -o nounset
set -o pipefail
ROOT=$(unset CDPATH && cd $(dirname "${BASH_SOURCE[0]}")/.. && pwd)
cd $ROOT
targetDocs="$ROOT/docs/api-references/docs.md"
verifyDocs_tmp=$(mktemp)
trap "rm -f $verifyDocs_tmp" EXIT
cp "$targetDocs" "${verifyDocs_tmp}"
targetFedDocs="$ROOT/docs/api-references/federation-docs.md"
verifyFedDocs_tmp=$(mktemp)
trap "rm -f $verifyFedDocs_tmp" EXIT
cp "$targetFedDocs" "${verifyFedDocs_tmp}"
hack/update-api-references.sh
echo "diffing $targetDocs with $verifyDocs_tmp" >&2
diff=$(diff "$targetDocs" "$verifyDocs_tmp") || true
if [[ -n "${diff}" ]]; then
echo "${diff}" >&2
echo >&2
echo "Run ./hack/update-api-references.sh" >&2
exit 1
fi
# verify for federation
echo "diffing $targetFedDocs with $verifyFedDocs_tmp" >&2
diff=$(diff "$targetFedDocs" "$verifyFedDocs_tmp") || true
if [[ -n "${diff}" ]]; then
echo "${diff}" >&2
echo >&2
echo "Run ./hack/update-api-references.sh" >&2
exit 1
fi