mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-23 11:50:44 +00:00
Add a script to verify that URLs in API documentation are valid
This commit is contained in:
parent
c6f3007071
commit
3808920328
@ -35,6 +35,7 @@ EXCLUDED_PATTERNS=(
|
|||||||
"verify-*-dockerized.sh" # Don't run any scripts that intended to be run dockerized
|
"verify-*-dockerized.sh" # Don't run any scripts that intended to be run dockerized
|
||||||
"verify-golangci-lint-pr.sh" # Don't run this as part of the block pull-kubernetes-verify yet. TODO(pohly): try this in a non-blocking job and then reconsider this.
|
"verify-golangci-lint-pr.sh" # Don't run this as part of the block pull-kubernetes-verify yet. TODO(pohly): try this in a non-blocking job and then reconsider this.
|
||||||
"verify-licenses.sh" # runs in a separate job to monitor availability of the dependencies periodically
|
"verify-licenses.sh" # runs in a separate job to monitor availability of the dependencies periodically
|
||||||
|
"verify-openapi-docs-urls.sh" # Spams docs URLs, don't run in CI.
|
||||||
)
|
)
|
||||||
|
|
||||||
# Exclude typecheck in certain cases, if they're running in a separate job.
|
# Exclude typecheck in certain cases, if they're running in a separate job.
|
||||||
|
55
hack/verify-openapi-docs-urls.sh
Executable file
55
hack/verify-openapi-docs-urls.sh
Executable file
@ -0,0 +1,55 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
# Copyright 2023 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 checks the documentation (description) from the OpenAPI specification for URLs, and
|
||||||
|
# verifies those URLs are valid.
|
||||||
|
# Usage: `hack/verify-openapi-docs-links.sh`.
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
|
||||||
|
KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
|
||||||
|
source "${KUBE_ROOT}/hack/lib/init.sh"
|
||||||
|
|
||||||
|
SPECROOT="${KUBE_ROOT}/api/openapi-spec"
|
||||||
|
SPECV3PATH="${SPECROOT}/v3"
|
||||||
|
|
||||||
|
_tmp="${KUBE_ROOT}/_tmp"
|
||||||
|
mkdir -p "${_tmp}"
|
||||||
|
trap 'rm -rf ${_tmp}' EXIT SIGINT
|
||||||
|
trap "echo Aborted; exit;" SIGINT SIGTERM
|
||||||
|
|
||||||
|
TMP_URLS="${_tmp}/docs_urls.txt"
|
||||||
|
touch "${TMP_URLS}"
|
||||||
|
|
||||||
|
|
||||||
|
for full_repo_path in "${SPECV3PATH}"/*.json; do
|
||||||
|
grep -oE '"description": ".*",?$' "$full_repo_path" | grep -oE 'https?:\/\/[-a-zA-Z0-9._+]{1,256}\.[a-zA-Z0-9]{1,6}\b([-a-zA-Z0-9:%_+.~&/=]*[a-zA-Z0-9])' >> "${TMP_URLS}" || true
|
||||||
|
done
|
||||||
|
sort -u "${TMP_URLS}" -o "${TMP_URLS}"
|
||||||
|
|
||||||
|
RESULT=0
|
||||||
|
while read -r URL; do
|
||||||
|
if ! curl --head --location --fail --silent "$URL" > /dev/null; then
|
||||||
|
echo "$URL not found"
|
||||||
|
RESULT=1
|
||||||
|
fi
|
||||||
|
done < "${TMP_URLS}"
|
||||||
|
|
||||||
|
exit $RESULT
|
||||||
|
|
||||||
|
# ex: ts=2 sw=2 et filetype=sh
|
Loading…
Reference in New Issue
Block a user