From de45ce7cb35652a20a0fb20171661a7e54bdbd8a Mon Sep 17 00:00:00 2001 From: Pravar Agrawal Date: Tue, 29 Jun 2021 22:13:05 +0530 Subject: add documentation for verify-boilerplate script --- contributors/devel/sig-testing/verify-tests.md | 11 +++++++++++ 1 file changed, 11 insertions(+) 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. -- cgit v1.2.3