github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
39df946c0660acb86a60097db479cb4ccad36ade
kubernetes/hack
History
Patrick Ohly 39df946c06 golangci-lint: enable doc comment checking for cmd/kubeadm 
Some code owners might want this for specific packages, like cmd/kubeadm.

This cannot be enabled for everything because:
- a lot of existing code doesn't pass (-> can't be in base config)
- a lot of packages don't need it (-> shouldn't even be a hint)
2023-10-25 12:30:28 +02:00
..
boilerplate
Cleanup boilerpate.py
2023-05-30 00:58:32 +03:00
conformance
e2e: remove redundant spaces in test names
2023-09-29 08:30:57 +02:00
e2e-internal
hack/update-bazel.sh
2021-02-28 15:17:29 -08:00
gen-swagger-doc
…
jenkins
Defer builds to test-cmd and test-integration targets
2023-02-01 15:35:14 -05:00
lib
Merge pull request #120423 from saschagrunert/gci-mounter-static
2023-09-26 06:50:00 -07:00
make-rules
hack: fix update of golangci-lint verify scripts
2023-10-10 09:03:20 +02:00
testdata
Move cri/streaming to k8s.io/kubelet staging repository
2023-06-05 08:08:18 +02:00
tools
update to golangci-lint v1.54.1 + go-ruleguard v0.4.0
2023-08-16 09:07:30 +02:00
verify-flags
kubelet: create top-level traces for pod sync and GC
2023-03-11 10:42:14 +01:00
.descriptions_failures
Add missing comments in APF API types
2021-06-25 00:27:40 -04:00
.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: enable doc comment checking for cmd/kubeadm
2023-10-25 12:30:28 +02:00
golangci-strict.yaml
golangci-lint: enable doc comment checking for cmd/kubeadm
2023-10-25 12:30:28 +02:00
golangci.yaml
golangci-lint: enable doc comment checking for cmd/kubeadm
2023-10-25 12:30:28 +02:00
golangci.yaml.in
golangci-lint: enable doc comment checking for cmd/kubeadm
2023-10-25 12:30:28 +02:00
grab-profiles.sh
Fix exit code check in hack/grab-profiles.sh
2021-05-17 14:47:05 +08:00
install-etcd.sh
…
install-protoc.sh
Add helper script to install protoc
2023-01-26 18:00:08 -05:00
lint-dependencies.sh
exit 1 if status are not as expected(order)
2023-06-18 14:09:50 +08:00
list-feature-tests.sh
…
local-up-cluster.sh
Add cni plugin auto Arch and OS selection
2023-09-09 20:33:12 +08:00
logcheck.conf
k8s.io/client-go/tools: support context for event recording
2023-09-27 09:06:09 +02: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
lavalamp is taking a long break
2023-05-11 16:43:38 +00:00
pin-dependency.sh
Stop adding explicit replace directives for all requires
2022-10-28 15:15:18 -04:00
print-workspace-status.sh
Remove invalid comments in hack/lib/version.sh
2022-07-06 19:19:29 +08:00
README.md
…
run-in-gopath.sh
…
run-prometheus-on-etcd-scrapes.sh
Add serving of scrapes as Prometheus metrics
2021-11-08 15:28:05 -05:00
serve-prom-scrapes.sh
Fixed typo in hack/serve-prom-scrapes.sh
2022-02-04 01:33:06 -05:00
test-go.sh
…
test-integration.sh
…
unwanted-dependencies.json
bump golang.org/grpc to v1.56.3
2023-10-19 15:20:07 -03: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
Use the same report files as before
2023-05-09 19:33:21 -07: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 CRD compatibility objects
2023-02-27 14:12:59 -05:00
update-generated-docs.sh
…
update-generated-proto-bindings-dockerized.sh
Check protoc version strictly
2023-01-26 18:00:06 -05:00
update-generated-protobuf-dockerized.sh
Check protoc version strictly
2023-01-26 18:00:06 -05: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-gofmt.sh
Make update-gofmt use ls-files
2023-01-22 15:16:23 -08:00
update-golangci-lint-config.sh
golangci-lint: suppress one issue, demote others to "hints"
2023-08-22 20:39:23 +02:00
update-import-aliases.sh
…
update-internal-modules.sh
[KMSv2] pkcs11 reference implementation using SoftHSM
2023-09-29 16:57:26 +00:00
update-kustomize.sh
Update kubectl kustomize to kyaml/v0.14.1, cmd/config/v0.11.1, api/v0.13.2, kustomize/v5.0.1
2023-03-14 11:40:28 -05:00
update-mocks.sh
cleanup update-mocks.sh
2023-04-21 16:15:21 -07:00
update-netparse-cve.sh
Make update-netparse-cve use ls-files
2023-01-22 15:21:37 -08:00
update-openapi-spec.sh
Capture discovery API output in test fixtures
2023-05-15 14:18:18 -04:00
update-translations.sh
i18n: Fix bug where package-level variables are not translated.
2022-11-21 22:48:42 -05:00
update-vendor-licenses.sh
Licensing: skip modules with fewer subdirs than mods
2023-01-03 16:48:35 +01:00
update-vendor.sh
prep for go1.21: use -e in go list
2023-08-17 17:46:30 +05:30
update-yamlfmt.sh
call kube::golang::setup_env before setting up worktree
2023-04-21 16:15:21 -07: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
Add discovery types
2022-10-19 17:27:25 +00:00
verify-boilerplate.sh
…
verify-cli-conventions.sh
…
verify-codegen.sh
hack: move common "verify generated" shell code into function
2023-08-22 20:39:23 +02:00
verify-conformance-requirements.sh
fix make verify (#115871)
2023-02-22 07:17:56 -08: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-e2e-suites.sh
e2e framework: track and report internal bugs
2023-10-10 18:15:46 +02: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
Drop zeitgeist from tools go.mod
2023-05-17 08:37:53 -04:00
verify-fieldname-docs.sh
Fix the name violation in apiextensions.k8s.io/v1,CustomResourceConversion, remove the failures file
2023-01-19 22:08:29 +08:00
verify-flags-underscore.py
use python3 in hack
2023-01-12 11:20:41 +08:00
verify-generated-docs.sh
…
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-gofmt.sh
cleanup verify-gofmt.sh
2021-03-07 12:51:33 -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
golangci-lint: suppress one issue, demote others to "hints"
2023-08-22 20:39:23 +02:00
verify-govet-levee.sh
verify-govet-levee.sh: optimize "go list"
2023-03-03 07:51:04 +01:00
verify-govulncheck.sh
Add/update prechecks to verify-govulncheck.sh
2023-09-27 21:05:17 +05:30
verify-import-aliases.sh
…
verify-import-boss.sh
Restrict what imports get into code within test/e2e_node
2023-08-21 15:04:23 -04:00
verify-imports.sh
…
verify-internal-modules.sh
hack: move common "verify generated" shell code into function
2023-08-22 20:39:23 +02:00
verify-licenses.sh
call kube::golang::setup_env before setting up worktree
2023-04-21 16:15:21 -07: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
update and verify netparse
2021-08-20 10:42:09 +02:00
verify-no-vendor-cycles.sh
Update go.mod files to go1.18, update license vendor script
2022-05-04 10:22:27 -04:00
verify-non-mutating-validation.sh
add verify script to catch most validation mutations
2021-10-08 14:37:55 -04:00
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
Capture discovery API output in test fixtures
2023-05-15 14:18:18 -04: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 clearly unnecessary lingering BUILD file references
2022-10-04 16:47:25 -07:00
verify-shellcheck.sh
Update shellcheck version (0.7.2 -> 0.8.0) and fix findings
2022-11-08 11:53:57 +01:00
verify-spelling.sh
…
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
Handle AllAlpha and AllBeta in SetFeatureGateDuringTest
2023-03-02 22:24:19 -05:00
verify-test-images.sh
…
verify-typecheck-providerless.sh
providerless tag for client-go auth plugins
2021-03-28 20:07:59 -04:00
verify-typecheck.sh
Remove generated file rules in make
2022-10-04 08:50:30 -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
Improve vendor verification works for each staging repo
2023-01-10 09:30:47 -05: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.