History

Kubernetes Prow Robot 2c0fad1bc7 Merge pull request #87503 from liggitt/remove-alpha-node-api Drop k8s.io/node-api packages		2020-02-07 15:20:12 -08:00
..
boilerplate	Revert "76093 restructure LICENSES file generation"	2019-11-13 10:24:32 -05:00
conformance	…
e2e-internal	…
gen-swagger-doc	…
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 KUBE_TEST_API logic	2020-01-13 09:09:46 -05:00
testdata	Ensure testing credentials are labeled as such	2020-02-04 10:36:05 -08:00
verify-flags	…
.golint_failures	Merge pull request #87503 from liggitt/remove-alpha-node-api	2020-02-07 15:20:12 -08:00
.import-aliases	Modify alias of e2e/framework/job to e2ejob	2020-01-17 10:56:05 +09:00
.shellcheck_failures	fix shell checks errors in cluster/common.sh	2019-12-25 16:35:11 +08:00
.spelling_failures	…
.staticcheck_failures	fix staticcheck errors in vendor/k8s.io/legacy-cloud-providers/aws.	2020-02-06 11:08:45 +08:00
BUILD	…
OWNERS	add myself to hack/OWNERS	2020-02-04 11:46:35 -08:00
README.md	add README.md in hack/	2020-01-16 10:12:18 +08:00
benchmark-go.sh	add comment in several hack/ sh scripts.	2020-01-27 11:13:09 +09: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	…
dev-build-and-push.sh	…
dev-build-and-up.sh	…
dev-push-conformance.sh	…
e2e-node-test.sh	add comment in several hack/ sh scripts.	2020-01-27 11:13:09 +09:00
generate-bindata.sh	…
generate-docs.sh	…
get-build.sh	add comment in several hack/ sh scripts.	2020-01-27 11:13:09 +09:00
ginkgo-e2e.sh	Remove cluster-monitoring	2019-12-09 11:25:20 +01:00
grab-profiles.sh	…
install-etcd.sh	…
lint-dependencies.sh	…
list-feature-tests.sh	…
local-up-cluster.sh	Use standard default storage media type in local-up-cluster	2020-01-30 17:25:23 -05:00
pin-dependency.sh	add comment in hack/update-*.sh	2020-01-16 10:05:49 +08:00
print-workspace-status.sh	…
run-in-gopath.sh	…
test-go.sh	…
test-integration.sh	…
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	…
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	…
update-generated-docs.sh	…
update-generated-kms-dockerized.sh	…
update-generated-kms.sh	…
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	…
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	…
update-generated-protobuf-dockerized.sh	…
update-generated-protobuf.sh	…
update-generated-runtime-dockerized.sh	…
update-generated-runtime.sh	…
update-generated-swagger-docs.sh	…
update-gofmt.sh	…
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	…
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	…
verify-spelling.sh	Add simple explanation to verify-spelling.sh	2020-01-08 15:55:10 +09:00
verify-staging-meta-files.sh	…
verify-staticcheck.sh	…
verify-test-code.sh	…
verify-test-featuregates.sh	…
verify-test-images.sh	…
verify-typecheck-providerless.sh	add hack/verify-typecheck-providerless.sh	2019-12-04 22:30:23 -08:00
verify-typecheck.sh	…
verify-vendor-licenses.sh	Revert "76093 restructure LICENSES file generation"	2019-11-13 10:24:32 -05:00
verify-vendor.sh	Revert "76093 restructure LICENSES file generation"	2019-11-13 10:24:32 -05: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.