1#!/usr/bin/env bash
2
3# Copyright 2016 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 the description format of help message of kubectl command
18# is valid or not. And this checking is done for all kubectl sub-commands.
19# Usage: `hack/verify-cli-conventions.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"
27
28kube::golang::setup_env
29
30GOPROXY=off go install ./cmd/clicheck
31
32if ! output=$(clicheck 2>&1)
33then
34 echo "$output"
35 echo
36 echo "FAILURE: CLI is not following one or more required conventions."
37 exit 1
38else
39 echo "$output"
40 echo
41 echo "SUCCESS: CLI is following all tested conventions."
42fi
View as plain text