1#!/usr/bin/env bash
2
3# Copyright 2023 The Kubernetes Authors.
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17# This script checks API-related files for mismatch in docs and field names,
18# and outputs a list of fields that their docs and field names are mismatched.
19# Usage: `hack/verify-fieldname-docs.sh`.
20
21set -o errexit
22set -o nounset
23set -o pipefail
24
25KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
26source "${KUBE_ROOT}/hack/lib/init.sh"
27source "${KUBE_ROOT}/hack/lib/util.sh"
28
29kube::golang::setup_env
30
31GOPROXY=off go install ./cmd/fieldnamedocscheck
32
33find_files() {
34 find . -not \( \
35 \( \
36 -wholename '.git' \
37 -o -wholename './_output' \
38 -o -wholename './release' \
39 -o -wholename './target' \
40 -o -wholename '*/third_party/*' \
41 -o -wholename '*/vendor/*' \
42 -o -wholename './pkg/*' \
43 \) -prune \
44 \) \
45 \( -wholename './staging/src/k8s.io/api/*/v*/types.go' \
46 -o -wholename './staging/src/k8s.io/kube-aggregator/pkg/apis/*/v*/types.go' \
47 -o -wholename './staging/src/k8s.io/apiextensions-apiserver/pkg/apis/*/v*/types.go' \
48 \)
49}
50
51versioned_api_files=$(find_files) || true
52
53result=0
54for file in ${versioned_api_files}; do
55 package="${file%"/types.go"}"
56 echo "Checking ${package}"
57 fieldnamedocscheck -s "${file}" || result=$?
58done
59
60exit ${result}
View as plain text