verify-generated-docs.sh 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. #!/usr/bin/env bash
  2. # Copyright 2014 The Kubernetes Authors.
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. # This script checks that various type of documents(* .md, * .yaml and man
  16. # files) are generated correctly(just verifies the generation process).
  17. # Usage: `hack/verify-generated-docs.sh`.
  18. set -o errexit
  19. set -o nounset
  20. set -o pipefail
  21. KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
  22. source "${KUBE_ROOT}/hack/lib/init.sh"
  23. kube::golang::setup_env
  24. BINS=(
  25. cmd/gendocs
  26. cmd/genkubedocs
  27. cmd/genman
  28. cmd/genyaml
  29. )
  30. make -C "${KUBE_ROOT}" WHAT="${BINS[*]}"
  31. kube::util::ensure-temp-dir
  32. # just verify the generation process
  33. kube::util::gen-docs "${KUBE_TEMP}"