History

Joe Betz 3210f46b5b Add validation-gen to codegen scripts Add validation-gen to repository wide codegen scripts and introduce `./hack/update-codegen.sh validation` as a quick way to run validation-gen.		2025-03-03 09:49:50 -05:00
..
boilerplate	…
conformance	…
e2e-internal	…
gen-swagger-doc	…
jenkins	Merge pull request #130337 from pohly/hack-jenkins-split	2025-02-24 00:26:27 -08:00
lib	Bump images, dependencies and versions to go 1.24.0	2025-02-26 11:26:54 +01:00
make-rules	Honor KUBE_HACK_TOOLS_GOTOOLCHAIN	2025-02-14 13:01:59 -05:00
testdata	add --subresource to kubectl apply	2024-10-02 13:28:29 -04:00
tools	Bump hack/tools to github.com/golangci/golangci-lint 1.64.5 for go 1.24	2025-02-26 11:27:14 +01:00
verify-flags	…
.descriptions_failures	Add missing comments in k8s.io/api/core/v1	2024-11-07 18:42:33 -08:00
.import-aliases	…
.spelling_failures	…
OWNERS	…
README.md	…
_update-generated-proto-bindings-dockerized.sh	…
_update-generated-protobuf-dockerized.sh	…
apidiff.sh	chore: Update apidiff.sh script description	2024-12-16 13:44:48 -08: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	…
ginkgo-e2e.sh	hack/ginkgo-e2e.sh: forward TERM/INT to Ginkgo	2025-01-17 16:28:41 +01:00
golangci-hints.yaml	Bump hack/tools to github.com/golangci/golangci-lint 1.64.5 for go 1.24	2025-02-26 11:27:14 +01:00
golangci.yaml	golangci-lint: temporarily suppress known issues in the code base	2025-02-26 16:09:28 +01:00
golangci.yaml.in	golangci-lint: temporarily suppress known issues in the code base	2025-02-26 16:09:28 +01:00
grab-profiles.sh	…
install-etcd.sh	Skip Go target normalization in integration tests	2024-09-25 13:15:48 -07:00
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	Remove cloud-provider arg for kube-apiserver in local-up-cluster.sh	2025-02-19 22:09:16 +00:00
logcheck.conf	kubelet: Migrate pkg/kubelet/sysctl to contextual logging	2025-01-30 10:31:58 +02:00
module-graph.sh	…
pin-dependency.sh	…
print-workspace-status.sh	…
run-prometheus-on-etcd-scrapes.sh	…
serve-prom-scrapes.sh	…
test-go.sh	…
test-integration.sh	…
unwanted-dependencies.json	update go.opentelemetry.io dependencies to v1.33.0/v0.58.0	2025-03-01 19:18:34 +00:00
update-all.sh	…
update-codegen.sh	Add validation-gen to codegen scripts	2025-03-03 09:49:50 -05:00
update-conformance-yaml.sh	…
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	…
update-generated-docs.sh	…
update-generated-stable-metrics.sh	…
update-gofmt.sh	…
update-golangci-lint-config.sh	golangci-lint: remove "strict" checking	2025-02-02 18:50:27 +01:00
update-import-aliases.sh	…
update-internal-modules.sh	…
update-kustomize.sh	Simplify update-vendor.sh to use go work sync	2024-10-10 17:58:54 -04:00
update-mocks.sh	Honor KUBE_HACK_TOOLS_GOTOOLCHAIN	2025-02-14 13:01:59 -05:00
update-netparse-cve.sh	Honor KUBE_HACK_TOOLS_GOTOOLCHAIN	2025-02-14 13:01:59 -05:00
update-openapi-spec.sh	Remove feature disablement ConsistentListFromCache in update openapi script	2025-02-10 16:34:49 +00:00
update-translations.sh	…
update-vendor-licenses.sh	…
update-vendor.sh	Drop self-referencing replace directives	2024-10-17 15:51:15 -04:00
update-yamlfmt.sh	…
verify-all.sh	…
verify-api-groups.sh	…
verify-boilerplate.sh	…
verify-cli-conventions.sh	…
verify-codegen.sh	…
verify-conformance-requirements.sh	…
verify-conformance-yaml.sh	…
verify-description.sh	…
verify-e2e-images.sh	restrict permitted e2e images to known images list	2024-07-03 10:42:51 -07:00
verify-e2e-suites.sh	…
verify-e2e-test-ownership.sh	…
verify-external-dependencies-version.sh	update zeitgeist to v0.5.4	2024-10-21 09:57:12 +02:00
verify-featuregates.sh	Merge pull request #127753 from skitt/missing-go-env	2024-10-23 03:46:59 +01:00
verify-fieldname-docs.sh	…
verify-file-sizes.sh	…
verify-flags-underscore.py	…
verify-generated-docs.sh	…
verify-generated-stable-metrics.sh	…
verify-gofmt.sh	…
verify-golangci-lint-config.sh	…
verify-golangci-lint-pr-hints.sh	…
verify-golangci-lint-pr.sh	…
verify-golangci-lint.sh	Merge pull request #130176 from liggitt/go-tools	2025-02-14 12:22:21 -08:00
verify-govulncheck.sh	Bump govulncheck to 1.1.2	2024-07-03 17:17:41 +05:30
verify-import-aliases.sh	…
verify-import-boss.sh	…
verify-imports.sh	…
verify-internal-modules.sh	…
verify-licenses.sh	…
verify-mocks.sh	…
verify-netparse-cve.sh	…
verify-no-vendor-cycles.sh	…
verify-non-mutating-validation.sh	…
verify-openapi-docs-urls.sh	…
verify-openapi-spec.sh	…
verify-pkg-names.sh	…
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	Honor KUBE_HACK_TOOLS_GOTOOLCHAIN	2025-02-14 13:01:59 -05:00
verify-readonly-packages.sh	…
verify-shellcheck.sh	…
verify-spelling.sh	Honor KUBE_HACK_TOOLS_GOTOOLCHAIN	2025-02-14 13:01:59 -05:00
verify-staging-meta-files.sh	…
verify-test-code.sh	Provide link with e2e guidelines when verity-test-code.sh fails	2024-10-29 13:07:05 +01:00
verify-test-featuregates.sh	reorder retrygeneratename and fix feature gate to lint versioned features	2024-09-27 20:29:16 +00:00
verify-test-images.sh	…
verify-testing-import.sh	hack: configure Go environments where necessary	2024-09-26 23:32:33 +02: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	…
verify-vendor.sh	Simplify update-vendor.sh to use go work sync	2024-10-10 17:58:54 -04:00
verify-yamlfmt.sh	…

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.