githubmirror/kubernetes

hack/verify-generated-docs.sh

28 строк1 KB

Tim Hockin

Move doc-generation funcs into only caller

01 мар 2024, 09:07

01 мар 2024, 09:0714321ef

#!/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 checks that various type of documents(* .md, * .yaml and man
# files) are generated correctly(just verifies the generation process).
# Usage: `hack/verify-generated-docs.sh`.

set -o errexit
set -o nounset
set -o pipefail

KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
source "${KUBE_ROOT}/hack/lib/verify-generated.sh"

kube::verify::generated "Generated docs need to be updated" "Please run 'hack/update-generated-docs.sh'" hack/update-generated-docs.sh "$@"