Skip to content

Commit 46ace33

Browse files
authored
Merge pull request #7857 from pjsharath28/vpa-flag-documentation-enforcement
VPA: Enforce flag documentation check in CI
2 parents a58d346 + 21316a6 commit 46ace33

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

hack/verify-vpa-flags.sh

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#!/bin/bash
2+
3+
# Copyright 2025 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+
set -o errexit
18+
set -o nounset
19+
set -o pipefail
20+
21+
KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
22+
VPA_FLAGS_SCRIPT="${KUBE_ROOT}/vertical-pod-autoscaler/hack/verify-vpa-flags.sh"
23+
24+
echo "Running VPA flags verification..."
25+
"$VPA_FLAGS_SCRIPT"
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#!/bin/bash
2+
3+
# Copyright 2025 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+
set -o errexit
18+
set -o nounset
19+
set -o pipefail
20+
21+
SCRIPT_ROOT=$(realpath $(dirname "${BASH_SOURCE[0]}"))/..
22+
FLAG_FILE="${SCRIPT_ROOT}/docs/flags.md"
23+
GENERATE_FLAGS_SCRIPT="${SCRIPT_ROOT}/hack/generate-flags.sh"
24+
25+
existing_flags=$(<"$FLAG_FILE")
26+
"$GENERATE_FLAGS_SCRIPT"
27+
updated_flags=$(<"$FLAG_FILE")
28+
29+
if [[ "$existing_flags" != "$updated_flags" ]]; then
30+
echo "VPA flags are not up to date. Please run ${GENERATE_FLAGS_SCRIPT}"
31+
exit 1
32+
fi

0 commit comments

Comments
 (0)