Skip to content
This repository was archived by the owner on Mar 26, 2021. It is now read-only.

Commit 6fc60ba

Browse files
committed
Document how to run Go source verification scripts
1 parent df66704 commit 6fc60ba

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/development.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,21 @@ generated clients and other generated files.
116116
1. Add the generated files to your PR, preferably in a separate, generated-only
117117
commit so that they are easier to review.
118118

119+
## Verify Go source files
120+
121+
To verify and fix your Go source files:
122+
123+
1. Run from the root of this repository `./hack/verify-go-src.sh -v --rootdir $(pwd)`
124+
125+
This runs all the Go source verification scripts in
126+
[`./hack/go-tools/`](/hack/go-tools/).
127+
128+
You can also run any of the scripts individually. For example:
129+
130+
1. Run `./hack/go-tools/verify-govet.sh`
131+
132+
The return code of the script indicates success or failure.
133+
119134
## Interacting with the k8s-bot
120135

121136
The cluster-registry repo is monitored by the k8s-ci-robot. You can find a list

0 commit comments

Comments
 (0)