Skip to content

Commit de45ce7

Browse files
committed
add documentation for verify-boilerplate script
1 parent a52b7d6 commit de45ce7

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

contributors/devel/sig-testing/verify-tests.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,14 @@ script:
132132
"${KUBE_ROOT}/.kazelcfg.json" \
133133
"${KUBE_ROOT}/build/root/.kazelcfg.json"
134134
```
135+
136+
## `verify-boilerplate`
137+
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`.
142+
143+
Once we collect all the file names, we run a check to identify the
144+
files with wrong header. This check will only run if the file exists
145+
in the list mentioned above.

0 commit comments

Comments
 (0)