File tree Expand file tree Collapse file tree 1 file changed +24
-4
lines changed
contributors/devel/sig-testing Expand file tree Collapse file tree 1 file changed +24
-4
lines changed Original file line number Diff line number Diff line change @@ -135,11 +135,31 @@ script:
135135
136136## ` verify-boilerplate `
137137
138- This script checks for the boilerplate header for all the files,
139- whether the header is correct or wrong. The script collects all the
140- file names generated by ` hack/boilerplate/boilerplate.py ` script and
141- stores them into a list called ` files_need_boilerplate ` .
138+ This script checks for the license headers for all the files, whether
139+ the header is correct or wrong. The purpose of boilerplate headers is
140+ to identify license headers. The script collects all the file names
141+ generated by ` hack/boilerplate/boilerplate.py ` script and stores them
142+ into a list called ` files_need_boilerplate ` .
142143
143144Once we collect all the file names, we run a check to identify the
144145files with wrong header. This check will only run if the file exists
145146in the list mentioned above.
147+
148+
149+ ## ` verify-cli-conventions `
150+
151+ This script checks whether the description format of ` help ` message of
152+ kubectl command is valid or not. This check is done for all the
153+ ` kubectl ` sub-commands as well. The script first checks whether the go
154+ command is available or not in the ${PATH}. And then the binary
155+ ` cmd/clicheck ` is checked if it exists or not in the well-known output
156+ locations. It runs command checks on all the kubectl commands or subcommands like,
157+
158+ ``` bash
159+ kubectl version
160+ kubectl uncordon
161+ kubectl wait
162+ kubectl top node
163+ ```
164+ And if the output looks good i.e. CLI follows all tested conventions the test passes.
165+
You can’t perform that action at this time.
0 commit comments