History

Kubernetes Prow Robot 4a45ae3236 Merge pull request #87645 from fromanirh/topomgr-e2e-tests e2e-topology-manager: single-NUMA-node test		2020-02-14 08:06:19 -08:00
..
boilerplate	Revert "76093 restructure LICENSES file generation"	2019-11-13 10:24:32 -05:00
conformance	simplify regexp with raw string	2019-09-20 16:53:56 +08: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	scheduler benchmark: allow to override bench prefix	2019-12-04 18:45:48 +01:00
lib	Merge pull request #87653 from JieJhih/shell/util	2020-02-07 05:56:50 -08:00
make-rules	remove unused manifest-tool rules	2020-02-13 14:58:26 -08:00
testdata	Ensure testing credentials are labeled as such	2020-02-04 10:36:05 -08:00
verify-flags	Updated OWNERS files to include link to docs	2019-02-04 22:33:12 +01:00
.golint_failures	Merge pull request #87234 from KobayashiD27/fix-golint	2020-02-12 02:23:05 -08:00
.import-aliases	Modify alias of e2e/framework/job to e2ejob	2020-01-17 10:56:05 +09:00
.shellcheck_failures	Fix shellcheck warnings/errors in /build/lib/release.sh	2020-02-04 11:00:58 +01:00
.spelling_failures	review updates	2019-02-22 10:00:10 -08:00
.staticcheck_failures	Merge pull request #87403 from gavinfish/kubectl_pkg	2020-02-12 07:48:52 -08: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	e2e: topomgr: add test infra	2020-02-10 22:47:53 +01: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	Add comments in several hack/*.sh	2020-01-28 09:27:40 +09: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	Merge pull request #87595 from hase1128/add-comment-hack-script	2020-02-11 23:14:20 -08: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	Enable update-bazel.sh outside of GOPATH	2019-11-26 17:33:57 -05: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-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	Revert "76093 restructure LICENSES file generation"	2019-11-13 10:24:32 -05:00
update-vendor.sh	Revert "76093 restructure LICENSES file generation"	2019-11-13 10:24:32 -05: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	Add comments in several hack/verify-generated-*.sh	2020-01-17 14:20:48 +09: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	Add comments in several hack/verify-*.sh(g-r)	2020-01-20 17:10:55 +09:00
verify-govet.sh	Add comments in several hack/verify-*.sh(g-r)	2020-01-20 17:10:55 +09: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	add staging directories to import-boss verify script	2020-01-28 10:51:46 +01: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	Add comments in several hack/verify-*.sh(s-v)	2020-01-21 19:10:46 +09: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	Add comments in several hack/verify-*.sh(s-v)	2020-01-21 19:10:46 +09:00
verify-test-code.sh	Add comments in several hack/verify-*.sh(s-v)	2020-01-21 19:10:46 +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

README.md

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.