kubernetes/hack
2021-03-11 17:40:07 +08:00
..
boilerplate remove bazel from boilerplate 2021-03-07 15:27:45 -08:00
conformance hack/update-bazel.sh 2021-02-28 15:17:29 -08:00
e2e-internal hack/update-bazel.sh 2021-02-28 15:17:29 -08:00
gen-swagger-doc
jenkins benchmark-dockerized.sh: set KUBE_ROOT 2020-08-05 20:28:34 +00:00
lib Merge pull request #99773 from saschagrunert/build-memory 2021-03-09 16:08:07 -08:00
make-rules Server-Side Apply: Status Wiping/Reset Fields 2021-03-10 01:02:18 +00:00
testdata Merge pull request #97168 from PurelyApplied/levee-config-owned-by-sig-security 2021-03-09 16:07:17 -08:00
tools update hack/tools README.md 2021-03-07 13:10:43 -08:00
verify-flags
.descriptions_failures add descriptions to these event/types.go files 2021-03-03 19:06:50 +08:00
.import-aliases Promote PDBs to GA 2021-03-09 10:29:11 -05:00
.spelling_failures
.staticcheck_failures Merge pull request #97779 from tiloso/staticcheck-test-integration-gs 2021-03-10 16:04:23 -08:00
.structured_logging Add scripts to use klog/logcheck 2021-03-05 08:17:34 +00: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 Fix indent in cherry_pick_pull script 2019-10-17 17:43:29 +02:00
dev-build-and-push.sh
dev-build-and-up.sh
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 drop bazel from generate-bindata.sh 2021-03-07 14:24:15 -08:00
generate-docs.sh
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 Remove golang.org exception for preferring latest minimal version 2020-07-31 10:57:07 -04:00
list-feature-tests.sh Add comments in several hack/*.sh 2020-01-28 09:27:40 +09:00
local-up-cluster.sh local-up-cluster kubelet option opening readonly port 2020-12-02 09:46:24 +08:00
module-graph.sh Make sure the _output folder exists before using it from module-graph.sh 2020-07-07 01:19:59 -07:00
OWNERS hack: Add justaugustus as reviewer 2020-09-14 09:06:38 -04:00
pin-dependency.sh [go1.15] fix pin-dependency.sh to only use module info 2020-07-25 16:45:02 -04:00
print-workspace-status.sh update print-workspace-status.sh comment 2021-03-07 12:47:37 -08: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 ignore vendor in update-bazel.sh, ignore bazel in update-vendor.sh 2021-03-07 15:34:44 -08:00
update-codegen.sh Add extract apply function generation 2021-03-10 06:13:51 -08:00
update-conformance-yaml.sh port conformance yaml generation to hack 2021-02-28 00:54:54 -08: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
update-generated-docs.sh
update-generated-kms-dockerized.sh Build code-generator tools directly 2020-08-02 10:56:46 -04:00
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 podresources v1 API 2020-10-26 12:10:18 -07:00
update-generated-pod-resources.sh Add podresources v1 API 2020-10-26 12:10:18 -07:00
update-generated-protobuf-dockerized.sh Build code-generator tools directly 2020-08-02 10:56:46 -04: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 CRI v1 proto 2020-11-10 14:17:17 -08:00
update-generated-runtime.sh Add usage in some hack/update scripts 2020-05-26 21:49:38 -07:00
update-generated-stable-metrics.sh remove the rest of the bazel test wiring for metrics stability 2021-02-05 10:48:48 -08:00
update-generated-swagger-docs.sh Speed up update-swagger-docs 2020-08-02 10:56:46 -04:00
update-gofmt.sh
update-import-aliases.sh *.sh: cleanup all white noise 2020-05-29 09:56:00 +08:00
update-internal-modules.sh Rename _examples to examples 2021-01-25 10:20:46 -08:00
update-openapi-spec.sh Fix OpenAPI spec generator script 2020-12-14 10:10:33 +08:00
update-translations.sh *.sh: cleanup all white noise 2020-05-29 09:56:00 +08:00
update-vendor-licenses.sh handle longer vendor paths without go files 2020-09-21 14:48:19 -07:00
update-vendor.sh ignore vendor in update-bazel.sh, ignore bazel in update-vendor.sh 2021-03-07 15:34:44 -08:00
verify-all.sh Add comments in several hack/verify-*.sh 2020-01-16 13:54:58 +09:00
verify-api-groups.sh fix a few missed references 2020-09-02 11:45:10 -07:00
verify-bazel.sh update verify-bazel.sh comments 2021-03-07 13:02:39 -08: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-conformance-yaml.sh port conformance yaml generation to hack 2021-02-28 00:54:54 -08:00
verify-description.sh hack/verify-description.sh: correctly look for versioned API types 2021-03-02 21:50:40 +05:30
verify-external-dependencies-version.sh use sed to drop escape codes from zeitgeist output 2021-03-04 14:59:52 -08:00
verify-flags-underscore.py Merge pull request #92829 from marload/patch-0706-04 2020-10-19 19:12:07 -07:00
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 Rename _examples to examples 2021-01-25 10:20:46 -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 Add podresources v1 API 2020-10-26 12:10:18 -07: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 CRI v1 proto 2020-11-10 14:17:17 -08:00
verify-generated-stable-metrics.sh remove the rest of the bazel test wiring for metrics stability 2021-02-05 10:48:48 -08:00
verify-generated-swagger-docs.sh verify-generated-swagger-docs: remove unnecessary build 2020-09-15 19:30:58 -07:00
verify-gofmt.sh cleanup verify-gofmt.sh 2021-03-07 12:51:33 -08:00
verify-golangci-lint.sh Adds ineffassign to GO linter script. 2021-03-03 08:28:10 -08:00
verify-govet-levee.sh KEP-1933: add static analysis target to hack/ 2020-11-03 20:03:26 +00: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 Build code-generator tools directly 2020-08-02 10:56:46 -04:00
verify-imports.sh Add comments in several hack/verify-*.sh(g-r) 2020-01-20 17:10:55 +09:00
verify-internal-modules.sh Rename *-hack-tools.sh -> *-internal-modules.sh 2021-01-25 10:15:59 -08: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 Update verify-no-vendor-cycles to use dependencycheck 2020-08-01 08:11:05 -05:00
verify-openapi-spec.sh remove BUILD copy from verify-openapi-spec.sh 2021-02-28 15:57:13 -08: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 Change yaml.load() to safe_load() 2021-01-19 15:58:12 +10: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 allo overriding docker in shellcheck 2021-03-06 13:28:58 -08: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 set GOOS=linux for the staticcheck tool 2021-01-12 18:00:36 +08:00
verify-structured-logging.sh logcheck: check Windows files 2021-03-11 17:40:07 +08:00
verify-test-code.sh Use ExpectNoError(err) 2020-09-03 23:29:07 +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 fix all keps links 404 for kep folder migration 2021-02-01 19:41:59 +08:00
verify-typecheck.sh Rewrite typecheck against x/tools/go/packages 2020-06-26 11:12:06 -07:00
verify-vendor-licenses.sh Remove docker remote/docker-machine from build scripts 2020-12-30 12:37:51 -05:00
verify-vendor.sh Remove docker remote/docker-machine from build scripts 2020-12-30 12:37:51 -05: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.