Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comments in several hack/verify-*.sh(g-r) #87379

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion hack/verify-gofmt.sh
Expand Up @@ -14,7 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# GoFmt apparently is changing @ head...
# This script checks whether the source codes need to be formatted or not by
# `gofmt`. We should run `hack/update-gofmt.sh` if actually formats them.
# Usage: `hack/verify-gofmt.sh`.
# Note: GoFmt apparently is changing @ head...

set -o errexit
set -o nounset
Expand Down
2 changes: 1 addition & 1 deletion hack/verify-golint.sh
Expand Up @@ -16,7 +16,7 @@

# This script checks coding style for go language files in each
# Kubernetes package by golint.
# Usage: hack/verify-golint.sh
# Usage: `hack/verify-golint.sh`.

set -o errexit
set -o nounset
Expand Down
5 changes: 4 additions & 1 deletion hack/verify-govet.sh
Expand Up @@ -14,7 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# This script is a vestigial redirection. Please do not add "real" logic.
# This script vets all *.go files by running `go vet`. It is equivalent to
# `make vet`.
# Usage: `hack/verify-govet.sh` or `make vet`.
# Note: This script is a vestigial redirection. Please do not add "real" logic.

set -o errexit
set -o nounset
Expand Down
4 changes: 4 additions & 0 deletions hack/verify-import-aliases.sh
Expand Up @@ -14,6 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# This script verifies that all the imports have our preferred alias(es). The
# preferred aliases for imports are listed in `hack/.import-aliases`.
# Usage: `hack/verify-import-aliases.sh`.

set -o errexit
set -o nounset
set -o pipefail
Expand Down
5 changes: 5 additions & 0 deletions hack/verify-import-boss.sh
Expand Up @@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# This script checks import restrictions. The script looks for a file called
# `.import-restrictions` in each directory, then all imports of the package are
# checked against each "rule" in the file.
# Usage: `hack/verify-import-boss.sh`.

set -o errexit
set -o nounset
set -o pipefail
Expand Down
5 changes: 5 additions & 0 deletions hack/verify-imports.sh
Expand Up @@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# This script checks restricted packages are imported or not and outputs the
# result. Target directory's path and allowed packages against checking are
# listed in `staging/publishing/import-restrictions.yaml`.
# Usage: `hack/verify-imports.sh`.

set -o errexit
set -o nounset
set -o pipefail
Expand Down
2 changes: 1 addition & 1 deletion hack/verify-linkcheck.sh
Expand Up @@ -17,7 +17,7 @@
# This script extracts the links from types.go and .md files in pkg/api/,
# pkg/apis/ and docs/ directories, checks the status code of the response, and
# output the list of invalid links.
# Usage: hack/verify-linkcheck.sh
# Usage: `hack/verify-linkcheck.sh`.

set -o errexit
set -o nounset
Expand Down
4 changes: 4 additions & 0 deletions hack/verify-no-vendor-cycles.sh
Expand Up @@ -14,6 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# This script checks whether packages under `vendor` directory have cyclic
# dependencies on `main` or `staging` repositories.
# Usage: `hack/verify-no-vendor-cycles.sh`.

set -o errexit
set -o nounset
set -o pipefail
Expand Down
5 changes: 5 additions & 0 deletions hack/verify-openapi-spec.sh
Expand Up @@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# This script checks whether updating of OpenAPI specification is needed or not.
# We should run `hack/update-openapi-spec.sh` if OpenAPI specification is out of
# date.
# Usage: `hack/verify-openapi-spec.sh`.

set -o errexit
set -o nounset
set -o pipefail
Expand Down
3 changes: 2 additions & 1 deletion hack/verify-pkg-names.sh
Expand Up @@ -14,7 +14,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# Verify whether codes follow golang convention.
# This script verifies whether codes follow golang convention.
# Usage: `hack/verify-pkg-names.sh`.

set -o errexit
set -o nounset
Expand Down
7 changes: 4 additions & 3 deletions hack/verify-readonly-packages.sh
Expand Up @@ -14,9 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# verify-readonly-packages.sh checks whether between $KUBE_VERIFY_GIT_BRANCH and HEAD files
# in readonly directories were modified. A directory is readonly iff it contains a .readonly
# file. Being readonly DOES NOT apply recursively to subdirectories.
# This script checks whether between $KUBE_VERIFY_GIT_BRANCH and HEAD files in
# readonly directories were modified. A directory is readonly if it contains a
# .readonly file. Being readonly DOES NOT apply recursively to subdirectories.
# Usage: `hack/verify-readonly-packages.sh`.

set -o errexit
set -o nounset
Expand Down