Add comments in several hack/*.sh

This commit is contained in:
Jin Hase 2020-01-28 09:27:40 +09:00
parent d1dd6cb0ef
commit e992ec0d59
12 changed files with 40 additions and 15 deletions

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 retrieves the specified version of the Kubernetes tar.gz file via
# Google Cloud Storage.
# Usage: `hack/get-build.sh <version number or publication>`.
# Example: `./hack/get-build.sh release/latest`.
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 runs e2e tests on Google Cloud Platform.
# Usage: `hack/ginkgo-e2e.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 grabs profiles from running components.
# Usage: `hack/grab-profiles.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,8 +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.
# Convenience script to download and install etcd in third_party. # This script is convenience to download and install etcd in third_party.
# Mostly just used by CI. # Mostly just used by CI.
# Usage: `hack/install-etcd.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset

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 version dependencies of modules. It checks whether all
# pinned versions of checked dependencies match their preferred version or not.
# Usage: `hack/lint-dependencies.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -14,7 +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.
# A single script that lists all of the [Feature:.+] tests in our e2e suite. # This script lists all of the [Feature:.+] tests in our e2e suite.
# Usage: `hack/list-feature-tests.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

View File

@ -16,9 +16,11 @@
KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/.. KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
# This command builds and runs a local kubernetes cluster. # This script builds and runs a local kubernetes cluster. You may need to run
# You may need to run this as root to allow kubelet to open docker's socket, # this as root to allow kubelet to open docker's socket, and to write the test
# and to write the test CA in /var/run/kubernetes. # CA in /var/run/kubernetes.
# Usage: `hack/local-up-cluster.sh`.
DOCKER_OPTS=${DOCKER_OPTS:-""} DOCKER_OPTS=${DOCKER_OPTS:-""}
export DOCKER=(docker "${DOCKER_OPTS[@]}") export DOCKER=(docker "${DOCKER_OPTS[@]}")
DOCKER_ROOT=${DOCKER_ROOT:-""} DOCKER_ROOT=${DOCKER_ROOT:-""}

View File

@ -14,11 +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.
# Usage: # This script switches to the preferred version for specified module.
# hack/pin-dependency.sh $MODULE $SHA-OR-TAG # Usage: `hack/pin-dependency.sh $MODULE $SHA-OR-TAG`.
# # Example: `hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7`.
# Example:
# hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7
set -o errexit set -o errexit
set -o nounset set -o nounset

View File

@ -13,8 +13,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 command is used by bazel as the workspace_status_command # This script is used by bazel as the workspace_status_command to implement
# to implement build stamping with git information. # build stamping with git information.
# Usage: `hack/print-workspace-status.sh`.
set -o errexit set -o errexit
set -o nounset set -o nounset

View File

@ -15,9 +15,10 @@
# limitations under the License. # limitations under the License.
# This script sets up a temporary Kubernetes GOPATH and runs an arbitrary # This script sets up a temporary Kubernetes GOPATH and runs an arbitrary
# command under it. Go tooling requires that the current directory be under # command under it. Go tooling requires that the current directory be under
# GOPATH or else it fails to find some things, such as the vendor directory for # GOPATH or else it fails to find some things, such as the vendor directory for
# the project. # the project.
# Usage: `hack/run-in-gopath.sh <command>`.
set -o errexit set -o errexit
set -o nounset set -o nounset

View File

@ -14,7 +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 is a vestigial redirection. Please do not add "real" logic. # This script runs all *_test.go files. It is equivalent to `make test`.
# Usage: `hack/test-go.sh` or `make test`.
# 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,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 has been replaced by `make test-integration`.
# `make test-integration` runs all integration tests.
# Usage: `make test-integration`.
# 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