Add comments in several hack/verify-*.sh

This commit is contained in:
Jin Hase 2020-01-16 13:54:58 +09:00
parent 2b6d875504
commit e1eabf8576
9 changed files with 33 additions and 3 deletions

View File

@ -14,7 +14,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script is a vestigial redirection. Please do not add "real" logic. # This script runs all the verify scripts respectively, so we should run
# `hack/verify-all.sh` before submit a PR. It is equivalent to `make verify`.
# Usage: `hack/verify-all.sh` or `make verify`.
# Note: This script is a vestigial redirection. Please do not add "real" logic.
set -o errexit set -o errexit
set -o nounset set -o nounset

View File

@ -14,8 +14,8 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# locate all API groups by their packages and versions # This scripts locates all API groups by their packages and versions
# Usage: `hack/verify-api-groups.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset

View File

@ -13,6 +13,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script checks whether updating of the bazel compilation files is needed
# or not. We should run `hack/update-bazel.sh` if actually updates them.
# Usage: `hack/verify-bazel.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,6 +14,9 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script checks boilerplate header for all files.
# Usage: `hack/verify-boilerplate.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,6 +14,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script checks the description format of help message of kubectl command
# is valid or not. And this checking is done for all kubectl sub-commands.
# Usage: `hack/verify-cli-conventions.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script verifies whether code update is needed or not against the
# specific sub-projects. The sub-projects are listed below this script(the
# line that starts with `CODEGEN_PKG`).
# Usage: `hack/verify-codegen.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,6 +14,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script checks conformance tests follow the requirements as
# https://git.k8s.io/community/contributors/devel/sig-architecture/conformance-tests.md#conformance-test-requirements
# Usage: `hack/verify-conformance-requirements.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,6 +14,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script checks API-related files for missing descriptions and outputs a
# list of structs and fields that are missing descriptions.
# Usage: `hack/verify-description.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,6 +14,9 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# This script verifies that dependencies are up-to-date across different files
# Usage: `hack/verify-external-dependencies-version.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail