kubernetes/hack
2020-06-30 09:50:44 -07:00
..
boilerplate Purge almost all memories of godep 2020-05-07 21:49:00 -07: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 go1.14: update minimum required go version 2020-06-23 16:40:22 -04:00
make-rules *.sh: cleanup all white noise 2020-05-29 09:56:00 +08:00
testdata Fix kubectl create secret docker-registry 2020-05-15 12:14:03 +08:00
tools go1.14: update staticcheck for go 1.14, ignore new staticcheck warnings 2020-06-23 19:04:43 -04:00
verify-flags Updated OWNERS files to include link to docs 2019-02-04 22:33:12 +01:00
.golint_failures Fix API encoding inconsistencies in KubeSchedulerConfig 2020-06-24 09:03:35 +01:00
.import-aliases Merge pull request #91502 from deads2k/dyn-audit-removal-00 2020-05-29 11:56:20 -07:00
.shellcheck_failures Fix shellcheck warnings/errors in cluster/gce/upgrade.sh (#88576) 2020-04-30 21:26:06 -07:00
.spelling_failures review updates 2019-02-22 10:00:10 -08:00
.staticcheck_failures fix pkg/util/coverage staticcheck 2020-06-23 18:30:32 -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 Merge pull request #91555 from daixiang0/scr 2020-06-20 05:26:53 -07: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 go1.14: set -mod=mod while rebuilding/linting vendor and building licenses, preserve explicit imports in modules.txt 2020-06-23 19:04:43 -04: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 #91504 from pohly/local-up-cluster-snapshotter 2020-06-03 07:30:18 -07:00
OWNERS eparis to emeritus 2020-06-30 09:50:44 -07: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 *.sh: cleanup all white noise 2020-05-29 09:56:00 +08:00
update-bazel.sh Merge pull request #91555 from daixiang0/scr 2020-06-20 05:26:53 -07: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 Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-generated-protobuf-dockerized.sh Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-generated-protobuf.sh Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-generated-runtime-dockerized.sh Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-generated-runtime.sh Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-generated-swagger-docs.sh Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-gofmt.sh fix bug of hack/update-gofmt.sh 2019-04-13 03:29:51 +08:00
update-hack-tools.sh Restructure licenses again (revert cd4474a) 2020-05-07 21:48:59 -07:00
update-import-aliases.sh *.sh: cleanup all white noise 2020-05-29 09:56:00 +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 *.sh: cleanup all white noise 2020-05-29 09:56:00 +08:00
update-vendor-licenses.sh hack/update-vendor-licenses.sh: skip empty packages 2020-06-24 18:39:49 +02:00
update-vendor.sh Add a reminder to add/rm files 2020-06-25 13:40:17 -07: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 Make verify-api-groups.sh not depend on GOPATH 2020-06-16 21:40:09 -07:00
verify-bazel.sh Handle clean up of read only files. 2020-06-03 13:31:18 -07: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 openapi generation for the kube-aggregator 2020-06-05 11:10:08 +08: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 default import-boss --include-test-files=true 2020-04-28 08:41:36 -07: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-prerelease-lifecycle-tags.sh add prerelease-lifecycle verification to all beta APIs 2020-05-05 09:47:31 -04: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 Rewrite typecheck against x/tools/go/packages 2020-06-26 11:12:06 -07:00
verify-test-code.sh Add check for blocking tests in e2e framework 2020-06-15 18:08:19 +00: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-dockerless.sh Add typecheck-dockerless 2020-05-07 17:18:50 -04: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 Rewrite typecheck against x/tools/go/packages 2020-06-26 11:12:06 -07:00
verify-vendor-licenses.sh Restructure licenses again (revert cd4474a) 2020-05-07 21:48:59 -07:00
verify-vendor.sh Let verify-vendor operate on a dirty repo 2020-05-07 22:36:14 -07: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.