Merge pull request #5864 from pravarag/verify-documentation

Add documentation for multiple kubernetes/kubernetes/hack/verify* tests

1 files changed, 58 insertions, 0 deletions

diff --git a/contributors/devel/sig-testing/verify-tests.md b/contributors/devel/sig-testing/verify-tests.md
index 17943240..96c34cce 100644
--- a/contributors/devel/sig-testing/verify-tests.md
+++ b/contributors/devel/sig-testing/verify-tests.md
@@ -105,3 +105,61 @@ Finally the script checks that all external group versions
 (e.g. `foobar/v1`) are defined in `hack/lib/init.sh` in either the
 `KUBE_AVAILABLE_GROUP_VERSIONS` or `KUBE_NONSERVER_GROUP_VERSIONS`
 bash variables.
+
+### `verify-bazel`
+
+This verify-bazel script validates the removal of bazel related
+files. The script ensures no bazel related temporary, intermediate or
+output files remain as part of
+[KEP-2420](https://github.com/kubernetes/enhancements/issues/2420).
+
+## `verify-boilerplate`
+
+This script checks for the license headers for all the files, whether
+the header is correct or wrong. The purpose of boilerplate headers is
+to identify license headers. The script collects all the file names
+generated by `hack/boilerplate/boilerplate.py` script and stores them
+into a list called `files_need_boilerplate`.
+
+Once we collect all the file names, we run a check to identify the
+files with wrong header. This check will only run if the file exists
+in the list mentioned above.
+
+
+## `verify-cli-conventions`
+
+This script checks whether the description format of `help` message of
+kubectl command is valid or not. This check is done for all the
+`kubectl` sub-commands as well. The script first checks whether the go
+command is available or not in the ${PATH}. And then the binary
+`cmd/clicheck` is checked if it exists or not in the well-known output
+locations. It runs command checks on all the kubectl commands or subcommands like,
+
+```bash
+kubectl version
+kubectl uncordon
+kubectl wait
+kubectl top node
+```
+
+And if the output looks good i.e. CLI follows all tested conventions
+the test passes.
+
+
+## `verify-codegen`
+
+This script verifies if the code update is needed or not for specific
+sub-projects. It first verifies the correct Go version and creates Go
+path. The script checks for the updated code for below subprojects,
+
+```bash
+k8s.io/code-generator
+k8s.io/kube-aggregator
+k8s.io/sample-apiserver
+k8s.io/sample-controller
+k8s.io/apiextensions-apiserver
+k8s.io/metrics
+```
+
+Once it completes checking for code updates, later the script calls
+`update-codegen.sh` scripts.