Skip to content

Commit e46af3d

Browse files
committed
Document go:test task's environment variable parameters
The behavior of the `go:test` task can be configured via environment variables. It is important to document these parameter variables in order to make their existence known to contributors who would find them useful. Previously, the parameter environment variables of this task were undocumented.
1 parent 34febc1 commit e46af3d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

workflow-templates/assets/test-go-task/Taskfile.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ vars:
99
tasks:
1010
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-go-task/Taskfile.yml
1111
go:test:
12-
desc: Run unit tests
12+
desc: |
13+
Run unit tests.
14+
Environment variable parameters:
15+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
16+
- GO_PACKAGES: List of Go packages to test (default: all packages of the module).
1317
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
1418
cmds:
1519
- |

0 commit comments

Comments
 (0)