kubernetes/hack
Joakim Roubert bf77061cb1 Fix shellcheck failures in cluster/pre-existing/util.sh
This is merely bringing PR #82059 back to life in a contemporary
context, so all cred should go to k-toyoda-pi (and BenTheElder).

Change-Id: I7cf33e50adabbd23d18348448c21c6255502c1ba
Signed-off-by: Joakim Roubert <joakimr@axis.com>
2020-04-23 16:02:48 +02:00
..
boilerplate Revert "76093 restructure LICENSES file generation" 2019-11-13 10:24:32 -05:00
conformance Update conformance requirement check 2020-02-06 20:09:00 +00:00
e2e-internal make more of the shell pass lints 2019-02-18 22:50:03 -05:00
gen-swagger-doc Bash script syntax improvements 2019-01-19 13:58:58 +01:00
jenkins move linting dependencies to hack/tools/tools.go 2020-04-20 13:45:38 -04:00
lib Update default etcd server to 3.4.7 2020-04-13 14:37:56 -07:00
make-rules move linting dependencies to hack/tools/tools.go 2020-04-20 13:45:38 -04:00
testdata Even with build error, kubectl apply should apply all valid resources 2020-04-04 15:48:31 -07:00
tools Add Makefile and a note in README.md 2020-04-20 13:45:47 -04:00
verify-flags Updated OWNERS files to include link to docs 2019-02-04 22:33:12 +01:00
.golint_failures Merge pull request #88217 from gkarthiks/master 2020-04-16 08:38:46 -07:00
.import-aliases Update .import-aliases for e2e test framework 2020-03-25 11:40:02 +08:00
.shellcheck_failures Fix shellcheck failures in cluster/pre-existing/util.sh 2020-04-23 16:02:48 +02:00
.spelling_failures review updates 2019-02-22 10:00:10 -08:00
.staticcheck_failures Merge pull request #87405 from gavinfish/kubectl_pkg_cmd_set 2020-04-22 23:09:44 -07:00
benchmark-go.sh add comment in several hack/ sh scripts. 2020-01-27 11:13:09 +09:00
BUILD remove hack/e2e.go 2019-11-03 19:36:59 -05:00
build-cross.sh add comment in several hack/ sh scripts. 2020-01-27 11:13:09 +09:00
build-go.sh add comment in several hack/ sh scripts. 2020-01-27 11:13:09 +09:00
cherry_pick_pull.sh Fix indent in cherry_pick_pull script 2019-10-17 17:43:29 +02:00
dev-build-and-push.sh fix shellcheck failure 2019-01-22 08:39:55 +08:00
dev-build-and-up.sh fix shellcheck failure 2019-01-22 08:39:55 +08:00
dev-push-conformance.sh Adds an optional golang runner to the conformance test image 2019-07-01 16:26:13 -05:00
e2e-node-test.sh add comment in several hack/ sh scripts. 2020-01-27 11:13:09 +09:00
generate-bindata.sh add conformance testdata/ and make it available from bindata 2020-04-01 10:48:01 -04:00
generate-docs.sh fix some shellcheck failures in hack 2019-02-25 11:38:56 +08:00
get-build.sh Update get-build.sh 2020-01-29 09:27:51 +09:00
ginkgo-e2e.sh tests: Adds configurable docker conf for test 2020-02-22 22:21:28 -08:00
grab-profiles.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
install-etcd.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
lint-dependencies.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
list-feature-tests.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
local-up-cluster.sh Use sched ComponentConfig over individual command line args 2020-03-26 17:11:17 -07:00
OWNERS add myself to hack/OWNERS 2020-02-04 11:46:35 -08:00
pin-dependency.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
print-workspace-status.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
README.md add README.md in hack/ 2020-01-16 10:12:18 +08:00
run-in-gopath.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
test-go.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
test-integration.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
update-all.sh add comment in hack/update-*.sh 2020-01-16 10:05:49 +08:00
update-bazel.sh Do not include bazel related deps in root go.mod 2020-04-19 22:01:50 -04:00
update-codegen.sh Drop k8s.io/node-api packages 2020-02-07 10:07:14 -05:00
update-generated-api-compatibility-data.sh Add helper script to regenerate API compatibility data 2019-06-03 10:18:08 -04:00
update-generated-device-plugin-dockerized.sh add comment in hack/update-*.sh 2020-01-16 10:05:49 +08:00
update-generated-device-plugin.sh Fix shellcheck lint errors in ./hack/... 2019-02-20 01:31:58 -05:00
update-generated-docs.sh Fix shellcheck lint errors in ./hack/... 2019-02-20 01:31:58 -05:00
update-generated-kms-dockerized.sh fix shellcheck failures of hack/update-generated-kms-dockerized.sh hack/update-generated-protobuf-dockerized.sh 2019-04-15 01:57:36 +08:00
update-generated-kms.sh Fix shellcheck lint errors in ./hack/... 2019-02-20 01:31:58 -05:00
update-generated-kubelet-plugin-registration-dockerized.sh add comment in hack/update-*.sh 2020-01-16 10:05:49 +08:00
update-generated-kubelet-plugin-registration.sh Fix shellcheck lint errors in ./hack/... 2019-02-20 01:31:58 -05:00
update-generated-pod-resources-dockerized.sh add comment in hack/update-*.sh 2020-01-16 10:05:49 +08:00
update-generated-pod-resources.sh Fix shellcheck lint errors in ./hack/... 2019-02-20 01:31:58 -05:00
update-generated-protobuf-dockerized.sh fix shellcheck failures of hack/update-generated-kms-dockerized.sh hack/update-generated-protobuf-dockerized.sh 2019-04-15 01:57:36 +08:00
update-generated-protobuf.sh hack/*protobuf.sh: dynamically find api roots 2019-03-06 08:36:14 +01:00
update-generated-runtime-dockerized.sh fix shellcheck failures of hack/update-generated-runtime-dockerized.sh 2019-04-18 22:36:22 +08:00
update-generated-runtime.sh fix shellcheck lint errors in cluster and hack scripts 2019-02-24 11:15:35 +08:00
update-generated-swagger-docs.sh Fix verify-generated-swagger-docs script 2019-02-20 14:37:46 -08:00
update-gofmt.sh fix bug of hack/update-gofmt.sh 2019-04-13 03:29:51 +08:00
update-hack-tools.sh add update/verify for go.mod/sum files in hack/tools 2020-04-20 13:45:46 -04:00
update-import-aliases.sh add comment in hack/update-*.sh 2020-01-16 10:05:49 +08:00
update-openapi-spec.sh Merge pull request #84654 from liggitt/drop-openapi-version 2020-01-08 11:59:39 -08:00
update-translations.sh add comment in hack/update-*.sh 2020-01-16 10:05:49 +08:00
update-vendor-licenses.sh generate LICENSES used in tools 2020-04-20 13:45:46 -04:00
update-vendor.sh fix the bug that update-vendor.sh reports error when grep match failed 2020-03-28 15:50:24 +08:00
update-workspace-mirror.sh Fix shellcheck failures in update-workspace-mirror.sh 2019-04-08 14:40:26 -04:00
verify-all.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-api-groups.sh Withdraw the change of getting version variable 2020-01-27 08:26:04 +09:00
verify-bazel.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-boilerplate.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-cli-conventions.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-codegen.sh Drop k8s.io/node-api packages 2020-02-07 10:07:14 -05:00
verify-conformance-requirements.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-description.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-external-dependencies-version.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-flags-underscore.py
verify-generated-device-plugin.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-docs.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-files-remake.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-files.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-kms.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-kubelet-plugin-registration.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-pod-resources.sh fix mismatch between pod resources verify/update scripts 2020-03-28 20:25:36 -04:00
verify-generated-protobuf.sh add staging directories to import-boss verify script 2020-01-28 10:51:46 +01:00
verify-generated-runtime.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-generated-swagger-docs.sh Add comments in several hack/verify-generated-*.sh 2020-01-17 14:20:48 +09:00
verify-gofmt.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-golint.sh move linting dependencies to hack/tools/tools.go 2020-04-20 13:45:38 -04:00
verify-govet.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-hack-tools.sh add update/verify for go.mod/sum files in hack/tools 2020-04-20 13:45:46 -04:00
verify-import-aliases.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-import-boss.sh Enable import-boss check for integration test 2020-03-30 21:09:15 +00:00
verify-imports.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-linkcheck.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-no-vendor-cycles.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-openapi-spec.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-pkg-names.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-publishing-bot.py Drop k8s.io/node-api packages 2020-02-07 10:07:14 -05:00
verify-readonly-packages.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-shellcheck.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-spelling.sh move linting dependencies to hack/tools/tools.go 2020-04-20 13:45:38 -04:00
verify-staging-meta-files.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-staticcheck.sh move linting dependencies to hack/tools/tools.go 2020-04-20 13:45:38 -04:00
verify-test-code.sh Use ExpectNotEqual in test/e2e/network/ 2020-03-18 16:30:56 +09:00
verify-test-featuregates.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-test-images.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-typecheck-providerless.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-typecheck.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-vendor-licenses.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00
verify-vendor.sh Add comments in several hack/verify-*.sh(s-v) 2020-01-21 19:10:46 +09:00

Kubernetes hack GuideLines

This document describes how you can use the scripts from hack directory and gives a brief introduction and explanation of these scripts.

Overview

The hack directory contains many scripts that ensure continuous development of kubernetes, enhance the robustness of the code, improve development efficiency, etc. The explanations and descriptions of these scripts are helpful for contributors. For details, refer to the following guidelines.

Key scripts

  • verify-all.sh: This script is a vestigial redirection, Please do not add "real" logic. It is equivalent to make verify.
  • update-all.sh: This script is a vestigial redirection, Please do not add "real" logic. The true target of this makerule is hack/make-rules/update.sh.It is equivalent to make update.

Attention

Note that all scripts must be run from the Kubernetes root directory. We should run hack/verify-all.sh before submitting a PR and if anything fails run hack/update-all.sh.