diff --git a/hack/pin-dependency.sh b/hack/pin-dependency.sh index 9175709f5a7..12abff23d4e 100755 --- a/hack/pin-dependency.sh +++ b/hack/pin-dependency.sh @@ -14,6 +14,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +# Usage: +# hack/pin-dependency.sh $MODULE $SHA-OR-TAG +# +# Example: +# hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7 + set -o errexit set -o nounset set -o pipefail @@ -21,12 +27,6 @@ set -o pipefail KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/.. source "${KUBE_ROOT}/hack/lib/init.sh" -# Usage: -# hack/pin-dependency.sh $MODULE $SHA-OR-TAG -# -# Example: -# hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7 - # Explicitly opt into go modules, even though we're inside a GOPATH directory export GO111MODULE=on # Explicitly clear GOFLAGS, since GOFLAGS=-mod=vendor breaks dependency resolution while rebuilding vendor diff --git a/hack/update-all.sh b/hack/update-all.sh index 073311424f9..2d842bd02d0 100755 --- a/hack/update-all.sh +++ b/hack/update-all.sh @@ -16,6 +16,9 @@ # This script is a vestigial redirection. Please do not add "real" logic. # The "true" target of this makerule is `hack/make-rules/update.sh`. +# We should run `hack/update-all.sh` if anything fails after +# running `hack/verify-all.sh`. It is equivalent to `make update`. +# Usage: `hack/update-all.sh` or `make update`. set -o errexit set -o nounset diff --git a/hack/update-codegen.sh b/hack/update-codegen.sh index 55686d9d44e..2d4cf1a3983 100755 --- a/hack/update-codegen.sh +++ b/hack/update-codegen.sh @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +# Please do not add any logic to this shell script. Add logic to the go code +# that generates the set-gen program. + set -o errexit set -o nounset set -o pipefail @@ -34,10 +37,6 @@ clientgen=$(kube::util::find-binary "client-gen") listergen=$(kube::util::find-binary "lister-gen") informergen=$(kube::util::find-binary "informer-gen") -# Please do not add any logic to this shell script. Add logic to the go code -# that generates the set-gen program. -# - IFS=" " read -r -a GROUP_VERSIONS <<< "${KUBE_AVAILABLE_GROUP_VERSIONS}" GV_DIRS=() for gv in "${GROUP_VERSIONS[@]}"; do diff --git a/hack/update-generated-device-plugin-dockerized.sh b/hack/update-generated-device-plugin-dockerized.sh index 868d8007467..3f507511d2f 100755 --- a/hack/update-generated-device-plugin-dockerized.sh +++ b/hack/update-generated-device-plugin-dockerized.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script generates `*/api.pb.go` from the protobuf file `*/api.proto`. +# Example: +# kube::protoc::generate_proto "${DEVICE_PLUGIN_ALPHA}" + set -o errexit set -o nounset set -o pipefail diff --git a/hack/update-generated-kubelet-plugin-registration-dockerized.sh b/hack/update-generated-kubelet-plugin-registration-dockerized.sh index 720b235134b..778574bd93c 100755 --- a/hack/update-generated-kubelet-plugin-registration-dockerized.sh +++ b/hack/update-generated-kubelet-plugin-registration-dockerized.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script generates `*/api.pb.go` from the protobuf file `*/api.proto`. +# Example: +# kube::protoc::generate_proto "${KUBELET_PLUGIN_REGISTRATION_V1ALPHA}" + set -o errexit set -o nounset set -o pipefail diff --git a/hack/update-generated-pod-resources-dockerized.sh b/hack/update-generated-pod-resources-dockerized.sh index 8dcc2b5757e..3e8d52bc759 100755 --- a/hack/update-generated-pod-resources-dockerized.sh +++ b/hack/update-generated-pod-resources-dockerized.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script generates `*/api.pb.go` from the protobuf file `*/api.proto`. +# Example: +# kube::protoc::generate_proto "${POD_RESOURCES_ALPHA}" + set -o errexit set -o nounset set -o pipefail diff --git a/hack/update-import-aliases.sh b/hack/update-import-aliases.sh index baa9e8f86bb..ab096df054f 100755 --- a/hack/update-import-aliases.sh +++ b/hack/update-import-aliases.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script fixes imports programmatically according to +# all the imports that we have our preferred alias(es). +# Usage: `hack/update-import-aliases.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/update-translations.sh b/hack/update-translations.sh index 81fe810f8f2..e59920d0efc 100755 --- a/hack/update-translations.sh +++ b/hack/update-translations.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script updates `translations/kubectl/template.pot` for +# `pkg/kubectl/cmd/*.go pkg/kubectl/cmd/*/*.go`. +# Usage: `update-translations.sh`. + KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/.. source "${KUBE_ROOT}/hack/lib/util.sh"