Skip to content

Commit 7148336

Browse files
authored
Document the various test/sync commands (#3120)
1 parent 18ef3a9 commit 7148336

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,3 +414,32 @@ Your fresh ideas and contributions are welcome.
414414
### Go icon
415415

416416
The Go logo was designed by Renée French, and has been released under the Creative Commons 3.0 Attributions license.
417+
418+
419+
## All the tests
420+
421+
A collection of commands to update/validate/verify all the things in the Go repos.
422+
423+
```bash
424+
# Check JSON files
425+
./bin/configlet fmt
426+
./bin/configlet lint
427+
428+
# Check if files are up to date
429+
./bin/configlet sync
430+
431+
# Regenerate the cases_test.go files
432+
./bin/run-generators
433+
434+
# Check the example/exemplar solutions pass the tests
435+
./bin/run-tests
436+
437+
# Run the test runner for each test.
438+
# If there is any non-Docker output, the test runner probably can't parse the test file/data.
439+
# See the go-test-runner where you can run these tests without Docker via ./bin/test-examples.sh
440+
./bin/verify-exercises-in-docker
441+
442+
# Test the generator and tools
443+
cd "$(git rev-parse --show-toplevel)/gen"; GO111MODULE=off go test ./...
444+
cd "$(git rev-parse --show-toplevel)/gotools"; go test ./...
445+
```

0 commit comments

Comments
 (0)