From 093fd4ab02938bcda27c078590fb99897a03207a Mon Sep 17 00:00:00 2001 From: Jin Hase Date: Tue, 21 Jan 2020 19:10:46 +0900 Subject: [PATCH] Add comments in several hack/verify-*.sh(s-v) --- hack/verify-shellcheck.sh | 3 +++ hack/verify-spelling.sh | 2 +- hack/verify-staging-meta-files.sh | 4 ++++ hack/verify-staticcheck.sh | 5 +++++ hack/verify-test-code.sh | 4 ++++ hack/verify-test-featuregates.sh | 4 ++++ hack/verify-test-images.sh | 4 ++++ hack/verify-typecheck-providerless.sh | 3 +++ hack/verify-typecheck.sh | 3 +++ hack/verify-vendor-licenses.sh | 5 +++++ hack/verify-vendor.sh | 4 ++++ 11 files changed, 40 insertions(+), 1 deletion(-) diff --git a/hack/verify-shellcheck.sh b/hack/verify-shellcheck.sh index 9a87f4ca3c1..cd6f3203fad 100755 --- a/hack/verify-shellcheck.sh +++ b/hack/verify-shellcheck.sh @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script lints each shell script by `shellcheck`. +# Usage: `hack/verify-shellcheck.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-spelling.sh b/hack/verify-spelling.sh index b3d636b91af..ec738bcf2c7 100755 --- a/hack/verify-spelling.sh +++ b/hack/verify-spelling.sh @@ -15,7 +15,7 @@ # This script checks commonly misspelled English words in all files in the # working directory by client9/misspell package. -# Usage: hack/verify-spelling.sh +# Usage: `hack/verify-spelling.sh`. set -o errexit set -o nounset diff --git a/hack/verify-staging-meta-files.sh b/hack/verify-staging-meta-files.sh index dac7cdb77e4..989bfa71a9e 100755 --- a/hack/verify-staging-meta-files.sh +++ b/hack/verify-staging-meta-files.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether the expected metadata files (such as OWNERS and +# LICENSE) exist under the `staging/src/k8s.io/*` directories. +# Usage: `hack/verify-staging-meta-files.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-staticcheck.sh b/hack/verify-staticcheck.sh index 3466d50cc3c..d66f4474eba 100755 --- a/hack/verify-staticcheck.sh +++ b/hack/verify-staticcheck.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script lints each package by `staticcheck`. +# Usage: `hack/verify-staticcheck.sh`. +# NOTE: To ignore issues detected a package, add it to the +# `.staticcheck_failures` blacklist. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-test-code.sh b/hack/verify-test-code.sh index 992cd6fda10..de3db419efd 100755 --- a/hack/verify-test-code.sh +++ b/hack/verify-test-code.sh @@ -13,6 +13,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether e2e test code which contains `Expect()` but not use +# the e2e framework exists or not. +# Usage: `hack/verify-test-code.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-test-featuregates.sh b/hack/verify-test-featuregates.sh index 9de17ef58c3..e474ed10b04 100755 --- a/hack/verify-test-featuregates.sh +++ b/hack/verify-test-featuregates.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether mutable global feature gate is invocated correctly +# in `*_test.go` files. +# Usage: `hack/verify-test-featuregates.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-test-images.sh b/hack/verify-test-images.sh index d58e8bb01ac..2350369674d 100755 --- a/hack/verify-test-images.sh +++ b/hack/verify-test-images.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether the latest or untagged gcr.io image is in +# `test/e2e/*.go` files. +# Usage: `hack/verify-test-images.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-typecheck-providerless.sh b/hack/verify-typecheck-providerless.sh index f5b6f53474a..71be45efa33 100755 --- a/hack/verify-typecheck-providerless.sh +++ b/hack/verify-typecheck-providerless.sh @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script verifies the build without in-tree cloud providers. +# Usage: `hack/verify-typecheck-providerless.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-typecheck.sh b/hack/verify-typecheck.sh index a1b68a3f57a..cc078d3fb15 100755 --- a/hack/verify-typecheck.sh +++ b/hack/verify-typecheck.sh @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script does a fast type check of kubernetes code for all platforms. +# Usage: `hack/verify-typecheck.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-vendor-licenses.sh b/hack/verify-vendor-licenses.sh index 3f0ee540d1f..a4710f43c4c 100755 --- a/hack/verify-vendor-licenses.sh +++ b/hack/verify-vendor-licenses.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of vendor licenses file is needed +# or not. We should run `hack/update-vendor-licenses.sh` and commit the results, +# if actually updates them. +# Usage: `hack/verify-vendor-licenses.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-vendor.sh b/hack/verify-vendor.sh index b3875452ec8..2179f8b16a8 100755 --- a/hack/verify-vendor.sh +++ b/hack/verify-vendor.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether fixing of vendor directory or go.mod is needed or +# not. We should run `hack/update-vendor.sh` if actually fixes them. +# Usage: `hack/verify-vendor.sh`. + set -o errexit set -o nounset set -o pipefail