mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-10-30 21:30:16 +00:00
67 lines
1.8 KiB
Bash
Executable File
67 lines
1.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# Copyright 2014 The Kubernetes Authors.
|
|
#
|
|
# 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.
|
|
|
|
# This script extracts the links from types.go and .md files in pkg/api/,
|
|
# pkg/apis/ and docs/ directories, checks the status code of the response, and
|
|
# output the list of invalid links.
|
|
# Usage: `hack/verify-linkcheck.sh`.
|
|
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
|
|
source "${KUBE_ROOT}/hack/lib/init.sh"
|
|
|
|
kube::golang::setup_env
|
|
|
|
make -C "${KUBE_ROOT}" WHAT=cmd/linkcheck
|
|
|
|
linkcheck=$(kube::util::find-binary "linkcheck")
|
|
|
|
kube::util::ensure-temp-dir
|
|
OUTPUT="${KUBE_TEMP}"/linkcheck-output
|
|
cleanup() {
|
|
rm -rf "${OUTPUT}"
|
|
}
|
|
trap "cleanup" EXIT SIGINT
|
|
mkdir -p "$OUTPUT"
|
|
|
|
APIROOT="${KUBE_ROOT}/pkg/api/"
|
|
APISROOT="${KUBE_ROOT}/pkg/apis/"
|
|
DOCROOT="${KUBE_ROOT}/docs/"
|
|
ROOTS=("$APIROOT" "$APISROOT" "$DOCROOT")
|
|
found_invalid=false
|
|
for root in "${ROOTS[@]}"; do
|
|
"${linkcheck}" "--root-dir=${root}" 2> >(tee -a "${OUTPUT}/error" >&2) && ret=0 || ret=$?
|
|
if [[ $ret -eq 1 ]]; then
|
|
echo "Failed: found invalid links in ${root}."
|
|
found_invalid=true
|
|
fi
|
|
if [[ $ret -gt 1 ]]; then
|
|
echo "Error running linkcheck"
|
|
exit 1
|
|
fi
|
|
done
|
|
|
|
if [ ${found_invalid} = true ]; then
|
|
echo "Summary of invalid links:"
|
|
cat "${OUTPUT}/error"
|
|
exit 1
|
|
fi
|
|
|
|
# ex: ts=2 sw=2 et filetype=sh
|