Skip to content

Commit 5658578

Browse files
authored
Merge pull request #6127 from pravarag/verify-documentation
Add documentation for remaining hack/verify* tests
2 parents 43ffba4 + 2979af4 commit 5658578

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,3 +163,38 @@ k8s.io/metrics
163163

164164
Once it completes checking for code updates, later the script calls
165165
`update-codegen.sh` scripts.
166+
167+
168+
## `verify-structured-logging`
169+
170+
This script verifies if a package is properly migrated to structured
171+
logging or not. The script involves verification steps based on new
172+
klog methods which have few disallowed keywords like,
173+
174+
```bash
175+
* klog.Infof, klog.Info, klog.Infoln
176+
* klog.InfoDepth
177+
* klog.WarningDepth
178+
* klog.Error, klog.Errorf, klog.Errorln
179+
* klog.ErrorDepth
180+
```
181+
182+
More info is available
183+
[here](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#change-log-functions-to-structured-equivalent).
184+
185+
186+
## `verify-gofmt`
187+
188+
This script is used to check whether the go source code needs to be
189+
formatted or not using, the gofmt tool. Gofmt tool automatically
190+
formats the code and the formatted code is easier to read, write and
191+
maintain.
192+
193+
194+
## `verify-spelling`
195+
196+
This script uses `client9/misspell` package to search and correct
197+
commonly misspelled words as per the English language in all the files
198+
and directories under `kubernetes/kubernetes`.
199+
200+

0 commit comments

Comments
 (0)