History

Jordan Liggitt 102a9dbab1 Pin godebug default to go1.23		2024-09-11 15:34:37 -04: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	Bump images, dependencies and versions to go 1.23.0	2024-09-02 10:42:04 -06:00
make-rules	test: filter "go test" output with gotestsum instead of grep	2024-08-19 16:14:05 +02:00
testdata	add tests	2024-06-26 01:07:24 +08:00
tools	Pin godebug default to go1.23	2024-09-11 15:34:37 -04:00
verify-flags	…
.descriptions_failures	…
.import-aliases	scheduler: remove deprecated v1beta2 KubeSchedulerConfiguration	2023-08-17 13:27:21 +08:00
.spelling_failures	…
OWNERS	lavalamp is taking a long break	2023-05-11 16:43:38 +00:00
README.md	…
_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
apidiff.sh	hack/apidiff.sh: compare between two revisions, usability enhancements	2024-04-26 11:00:03 +02:00
benchmark-go.sh	…
build-cross.sh	…
build-go.sh	…
cherry_pick_pull.sh	Add release notes to the body of the pull request on create cherry-pick.	2024-08-26 20:58:51 +03:00
dev-build-and-push.sh	…
dev-build-and-up.sh	…
dev-push-conformance.sh	…
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	hack/ginkgo-e2e.sh: skip S character by default, add newlines in CI	2024-05-27 15:25:50 +02:00
golangci-hints.yaml	kubelet: Migrate DRA Manager to contextual logging	2024-08-22 11:12:41 +03:00
golangci-strict.yaml	kubelet: Migrate DRA Manager to contextual logging	2024-08-22 11:12:41 +03:00
golangci.yaml	kubelet: Migrate DRA Manager to contextual logging	2024-08-22 11:12:41 +03:00
golangci.yaml.in	Merge pull request #125926 from MadhavJivrajani/bump-staticcheck-exclude-SA1006	2024-07-15 10:05:19 -07:00
grab-profiles.sh	…
install-etcd.sh	…
install-protoc.sh	…
lint-dependencies.sh	Add guard for dependencies recursively depending on kubernetes or staging modules	2024-09-04 16:58:04 -04:00
list-feature-tests.sh	…
local-up-cluster.sh	Update cni-plugins to v1.5.1	2024-08-28 12:58:36 +02:00
logcheck.conf	kubelet: Migrate DRA Manager to contextual logging	2024-08-22 11:12:41 +03:00
module-graph.sh	…
pin-dependency.sh	Remove _tmp from pin-dependency	2024-03-05 21:44:43 -08:00
print-workspace-status.sh	…
run-prometheus-on-etcd-scrapes.sh	…
serve-prom-scrapes.sh	…
test-go.sh	…
test-integration.sh	…
unwanted-dependencies.json	Update unwanted dependencies	2024-08-27 15:40:54 +00:00
update-all.sh	…
update-codegen.sh	DRA: new API for 1.31	2024-07-22 18:09:34 +02:00
update-conformance-yaml.sh	Revert "Save a list of images used by e2e.test"	2024-01-12 13:15:01 -08:00
update-featuregates.sh	Verify: add static analysis to verify new feature gates are added as versioned feature specs.	2024-08-01 13:52:32 -07: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	Fix the dirname command in macOS does not have a -z option	2024-03-10 23:44:10 +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	update-kustomize: update the Go workspace	2024-05-28 10:40:04 +02:00
update-mocks.sh	Handle all mock header generation with mockery	2024-08-05 11:19:37 +02: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	Remove v2beta1 aggregated discovery from being generated	2024-08-29 18:08:11 +00:00
update-translations.sh	…
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	…
verify-api-groups.sh	removed this k8s.io/kubernetes/pkg/apis/componentconfig from verify-api-groups.sh	2024-04-13 05:26:16 -04: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-images.sh	restrict permitted e2e images to known images list	2024-07-03 10:42:51 -07:00
verify-e2e-suites.sh	hack/verify-e2e-suites.sh: non-zero exit code when there were errors	2024-04-17 19:35:22 +02:00
verify-e2e-test-ownership.sh	…
verify-external-dependencies-version.sh	bump zeitgeist to release v0.5.3	2024-05-08 10:20:31 +02:00
verify-featuregates.sh	Verify: add static analysis to verify new feature gates are added as versioned feature specs.	2024-08-01 13:52:32 -07: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	Changed to use "wc -c" to ensure the command works on both Linux and Mac OS X with a single implementation	2024-04-20 04:39:50 +09: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	enhance boolean assertions	2024-07-31 15:58:15 +00:00
verify-govulncheck.sh	Bump govulncheck to 1.1.2	2024-07-03 17:17:41 +05:30
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	Remove _tmp from verify-openapi-docs-urls	2024-03-05 21:44:44 -08:00
verify-openapi-spec.sh	Make verify-openapi-spec use verify::generated	2024-03-05 21:44:41 -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	enforce that GA apis also have lifecycle tags	2024-05-21 13:27:01 -07:00
verify-prometheus-imports.sh	…
verify-publishing-bot.sh	rewrite publishing-bot verify script in go	2024-09-06 09:30:51 +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	…
verify-test-featuregates.sh	Cleanup defer from SetFeatureGateDuringTest function call	2024-04-24 20:25:29 +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.sh	Fix for typecheck doesn't notice compile errors in test files	2024-07-04 15:01:41 -04:00
verify-vendor-licenses.sh	Make vendor-licenses use verify::generated	2024-03-05 21:44:43 -08:00
verify-vendor.sh	Fix verify-vendor script to check all go.mod and go.sum files	2024-07-25 10:39:11 -04: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.