summaryrefslogtreecommitdiff
path: root/contributors
diff options
context:
space:
mode:
authorPravar Agrawal <pravaag1@in.ibm.com>2021-06-29 22:13:05 +0530
committerPravar Agrawal <pravaag1@in.ibm.com>2021-10-05 21:39:00 +0530
commitde45ce7cb35652a20a0fb20171661a7e54bdbd8a (patch)
tree14ed9bee6c9003c4be75f3b8355609aae8140bd1 /contributors
parenta52b7d6dd23479f8d8cfa88d33fb759b849c074f (diff)
add documentation for verify-boilerplate script
Diffstat (limited to 'contributors')
-rw-r--r--contributors/devel/sig-testing/verify-tests.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/contributors/devel/sig-testing/verify-tests.md b/contributors/devel/sig-testing/verify-tests.md
index 24ef6320..c22213c4 100644
--- a/contributors/devel/sig-testing/verify-tests.md
+++ b/contributors/devel/sig-testing/verify-tests.md
@@ -132,3 +132,14 @@ script:
"${KUBE_ROOT}/.kazelcfg.json" \
"${KUBE_ROOT}/build/root/.kazelcfg.json"
```
+
+## `verify-boilerplate`
+
+This script checks for the boilerplate header for all the files,
+whether the header is correct or wrong. 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.