History

Kubernetes Prow Robot 19df52c41a Merge pull request #123647 from thockin/use_go_-C_instead_of_pushd_popd Change `pushd $d; go ...; popd` to `go -C $d ...`		2024-03-02 16:41:56 -08:00
..
boilerplate	Get rid of most references to GOPATH	2024-02-29 22:06:51 -08:00
conformance	e2e: remove redundant spaces in test names	2023-09-29 08:30:57 +02:00
e2e-internal
gen-swagger-doc
jenkins	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
lib	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
make-rules	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
testdata	Drop hack/verify-govet-levee	2024-01-04 21:06:52 -05:00
tools	Generate go.work files	2024-02-29 00:22:06 -08:00
verify-flags	kubelet: create top-level traces for pod sync and GC	2023-03-11 10:42:14 +01:00
_update-generated-proto-bindings-dockerized.sh	Rename update-generated-* dockerized	2024-02-29 22:07:04 -08:00
_update-generated-protobuf-dockerized.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
.descriptions_failures
.import-aliases	scheduler: remove deprecated v1beta2 KubeSchedulerConfiguration	2023-08-17 13:27:21 +08:00
.spelling_failures	Add gimme	2023-02-01 16:34:23 -05:00
benchmark-go.sh
build-cross.sh
build-go.sh
cherry_pick_pull.sh	Update cherry_pick_pull.sh	2022-06-26 09:21:05 +05:30
dev-build-and-push.sh
dev-build-and-up.sh
dev-push-conformance.sh	Build `Ginkgo` binary	2022-07-08 10:46:11 +08:00
e2e-node-test.sh
generate-docs.sh
get-build.sh	fix: use dl.k8s.io, not kubernetes-release bucket	2023-05-13 10:57:41 +00:00
ginkgo-e2e.sh	Fix ginkgo deprecation warning	2023-05-31 12:53:11 +03:00
golangci-hints.yaml	golangci-lint: add hints for error wrapping	2024-02-13 14:12:04 +01:00
golangci-strict.yaml	Migrate cmd/kube-proxy to contextual logging (#122197 )	2024-01-08 17:30:18 +01:00
golangci.yaml	Migrate cmd/kube-proxy to contextual logging (#122197 )	2024-01-08 17:30:18 +01:00
golangci.yaml.in	golangci-lint: add hints for error wrapping	2024-02-13 14:12:04 +01:00
grab-profiles.sh
install-etcd.sh
install-protoc.sh	Add helper script to install protoc	2023-01-26 18:00:08 -05:00
lint-dependencies.sh	Make golang::setup-env turn on workspaces	2024-02-29 22:07:42 -08:00
list-feature-tests.sh
local-up-cluster.sh	Configure cpumanager policy options in local-up-cluster	2024-03-01 11:38:02 +01:00
logcheck.conf	Migrate cmd/kube-proxy to contextual logging (#122197 )	2024-01-08 17:30:18 +01:00
module-graph.sh
OWNERS	lavalamp is taking a long break	2023-05-11 16:43:38 +00:00
pin-dependency.sh	Make golang::setup-env turn on workspaces	2024-02-29 22:07:42 -08:00
print-workspace-status.sh	Remove invalid comments in hack/lib/version.sh	2022-07-06 19:19:29 +08:00
README.md
run-prometheus-on-etcd-scrapes.sh
serve-prom-scrapes.sh
test-go.sh
test-integration.sh
unwanted-dependencies.json	chore: Cleanup in-tree credential provider azure and cloud provider azure	2024-01-20 15:18:31 +08:00
update-all.sh	refactor(hack): use ${BASH_SOURCE[0]} to get script name	2022-04-16 23:58:13 +08:00
update-codegen.sh	Make update-codegen avoid sub-workspaces	2024-02-29 22:10:39 -08:00
update-conformance-yaml.sh	Revert "Save a list of images used by e2e.test"	2024-01-12 13:15:01 -08:00
update-generated-api-compatibility-data.sh	Rename new::setup_env back to setup_env	2024-02-29 22:06:44 -08:00
update-generated-docs.sh	Move doc-generation funcs into only caller	2024-02-29 22:07:33 -08:00
update-generated-stable-metrics.sh
update-go-workspace.sh	Add a header to go.work	2024-03-01 16:23:21 -08:00
update-gofmt.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
update-golangci-lint-config.sh	Rename new::setup_env back to setup_env	2024-02-29 22:06:44 -08:00
update-import-aliases.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
update-internal-modules.sh	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
update-kustomize.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
update-mocks.sh	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
update-netparse-cve.sh	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
update-openapi-spec.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
update-translations.sh	i18n: Fix bug where package-level variables are not translated.	2022-11-21 22:48:42 -05:00
update-vanity-imports.sh	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
update-vendor-licenses.sh	Tidy update-vendor-licenses for workspaces	2024-02-29 22:06:53 -08:00
update-vendor.sh	Make update-vendor log the go env	2024-02-29 22:07:08 -08:00
update-yamlfmt.sh	Remove legacy references to './output'	2024-02-29 22:07:31 -08:00
verify-all.sh	refactor(hack): use ${BASH_SOURCE[0]} to get script name	2022-04-16 23:58:13 +08:00
verify-api-groups.sh	Change verify-api-groups.sh to s/vendor/staging/	2024-02-29 22:06:01 -08:00
verify-boilerplate.sh
verify-cli-conventions.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
verify-codegen.sh	hack: move common "verify generated" shell code into function	2023-08-22 20:39:23 +02:00
verify-conformance-requirements.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
verify-conformance-yaml.sh	Revert "Save a list of images used by e2e.test"	2024-01-12 13:15:01 -08:00
verify-description.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
verify-e2e-suites.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
verify-e2e-test-ownership.sh	declare and assign seperately in hack/verify-e2e-test-ownership.sh	2022-10-19 23:46:18 -07:00
verify-external-dependencies-version.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
verify-fieldname-docs.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
verify-file-sizes.sh	verify-file-sizes.sh: ensure that no large binary files get added	2023-10-26 20:08:09 +02:00
verify-flags-underscore.py	Get rid of most references to GOPATH	2024-02-29 22:06:51 -08:00
verify-generated-docs.sh	Move doc-generation funcs into only caller	2024-02-29 22:07:33 -08:00
verify-generated-stable-metrics.sh
verify-go-workspace.sh	Remove references to "GO111MODULE"	2024-02-29 22:06:55 -08:00
verify-gofmt.sh	Remove legacy references to './output'	2024-02-29 22:07:31 -08:00
verify-golangci-lint-config.sh	golangci-lint: suppress one issue, demote others to "hints"	2023-08-22 20:39:23 +02:00
verify-golangci-lint-pr-hints.sh	hack: update golangci-lint verify scripts	2023-10-09 20:14:47 +02:00
verify-golangci-lint-pr.sh	hack: update golangci-lint verify scripts	2023-10-09 20:14:47 +02:00
verify-golangci-lint.sh	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
verify-govulncheck.sh	Rename new::setup_env back to setup_env	2024-02-29 22:06:44 -08:00
verify-import-aliases.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
verify-import-boss.sh	Move import-boss: k/code-generator/cmd -> k/k/cmd	2024-02-29 22:07:36 -08:00
verify-imports.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
verify-internal-modules.sh	hack: move common "verify generated" shell code into function	2023-08-22 20:39:23 +02:00
verify-licenses.sh	Rename new::setup_env back to setup_env	2024-02-29 22:06:44 -08:00
verify-mocks.sh	hack: move common "verify generated" shell code into function	2023-08-22 20:39:23 +02:00
verify-netparse-cve.sh	Remove legacy references to './output'	2024-02-29 22:07:31 -08:00
verify-no-vendor-cycles.sh	Call verify_go_version at the END of setup_env	2024-02-29 22:06:56 -08:00
verify-non-mutating-validation.sh
verify-openapi-docs-urls.sh	Add a script to verify that URLs in API documentation are valid	2023-03-13 11:37:59 -07:00
verify-openapi-spec.sh	Make hack scripts use `go install` and assume PATH	2024-02-29 22:07:32 -08:00
verify-pkg-names.sh	remove unnecessary kube::golang::verify_go_version calls	2023-09-11 14:06:28 -07:00
verify-prerelease-lifecycle-tags.sh	remove unnecessary kube::golang::verify_go_version calls	2023-09-11 14:06:28 -07:00
verify-prometheus-imports.sh	kubelet: Force deleted pods can fail to move out of terminating	2023-03-08 22:03:51 -06:00
verify-publishing-bot.py	update verify script to check deprecated fields	2023-09-25 21:37:40 +05:30
verify-readonly-packages.sh	Remove legacy references to './output'	2024-02-29 22:07:31 -08:00
verify-shellcheck.sh	Make verify-shellcheck take optional args	2024-02-29 22:07:05 -08:00
verify-spelling.sh	Change `pushd $d; go ...; popd` to `go -C $d ...`	2024-03-02 14:40:10 -08:00
verify-staging-meta-files.sh
verify-test-code.sh	e2e framework: deprecate gomega wrappers	2023-02-23 09:51:42 +01:00
verify-test-featuregates.sh	add test for the registered feature gates	2024-01-07 18:10:25 +02:00
verify-test-images.sh
verify-testing-import.sh	enable testing import check for kubeadm binary	2024-01-25 19:56:42 +08:00
verify-typecheck-providerless.sh	Add KUBE_PROVIDERLESS for CI jobs to run with providerless tag	2024-01-07 15:20:57 -05:00
verify-typecheck.sh	Retool typecheck to be simpler	2024-02-29 22:07:00 -08:00
verify-vendor-licenses.sh
verify-vendor.sh	Call setup_env from verify-vendor	2024-02-29 22:06:54 -08:00
verify-yamlfmt.sh	hack: move common "verify generated" shell code into function	2023-08-22 20:39:23 +02: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.