Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 4de008f

Browse files
authored
Merge pull request #934 from per1234/task-param-docs
Improve task parameter environment variable documentation
2 parents e9eab18 + a29f6f5 commit 4de008f

File tree

1 file changed

+55
-23
lines changed

1 file changed

+55
-23
lines changed

‎Taskfile.yml‎

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -289,14 +289,22 @@ tasks:
289289

290290
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
291291
go:fix:
292-
desc: Modernize usages of outdated APIs
292+
desc: |
293+
Modernize usages of outdated APIs.
294+
Environment variable parameters:
295+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
296+
- GO_PACKAGES: List of Go packages to modernize (default: all packages of the module).
293297
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
294298
cmds:
295299
- go fix {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
296300

297301
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
298302
go:format:
299-
desc: Format Go code
303+
desc: |
304+
Format Go code.
305+
Environment variable parameters:
306+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
307+
- GO_PACKAGES: List of Go packages to modernize (default: all packages of the module).
300308
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
301309
cmds:
302310
- go fmt {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
@@ -313,7 +321,11 @@ tasks:
313321

314322
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
315323
go:lint:
316-
desc: Lint Go code
324+
desc: |
325+
Lint Go code
326+
Environment variable parameters:
327+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
328+
- GO_PACKAGES: List of Go packages to modernize (default: all packages of the module).
317329
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
318330
cmds:
319331
- |
@@ -342,7 +354,11 @@ tasks:
342354

343355
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-go-task/Taskfile.yml
344356
go:test:
345-
desc: Run unit tests
357+
desc: |
358+
Run unit tests.
359+
Environment variable parameters:
360+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
361+
- GO_PACKAGES: List of Go packages to test (default: all packages of the module).
346362
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
347363
cmds:
348364
- |
@@ -374,7 +390,10 @@ tasks:
374390
375391
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
376392
go:tidy:
377-
desc: Refresh dependency metadata
393+
desc: |
394+
Refresh dependency metadata.
395+
Environment variable parameters:
396+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
378397
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
379398
vars:
380399
GO_VERSION: 1.24.0
@@ -383,7 +402,11 @@ tasks:
383402

384403
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
385404
go:vet:
386-
desc: Check for errors in Go code
405+
desc: |
406+
Check for errors in Go code.
407+
Environment variable parameters:
408+
- GO_MODULE_PATH: Path of the Go module root (default: {{.DEFAULT_GO_MODULE_PATH}}).
409+
- GO_PACKAGES: List of Go packages to test (default: all packages of the module).
387410
dir: "{{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
388411
cmds:
389412
- go vet {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
@@ -454,21 +477,23 @@ tasks:
454477
markdownlint-cli \
455478
"**/*.md"
456479
457-
# Parameter variables:
458-
# - PROJECT_PATH: path of the npm-managed project. Default value: "./"
459480
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/npm-task/Taskfile.yml
460481
npm:install-deps:
461-
desc: Install dependencies managed by npm
482+
desc: |
483+
Install dependencies managed by npm.
484+
Environment variable parameters:
485+
- PROJECT_PATH: Path of the npm-managed project (default: {{.DEFAULT_NPM_PROJECT_PATH}}).
462486
dir: |
463487
"{{default .DEFAULT_NPM_PROJECT_PATH .PROJECT_PATH}}"
464488
cmds:
465489
- npm install
466490

467-
# Parameter variables:
468-
# - PROJECT_PATH: path of the npm-managed project. Default value: "./"
469491
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-npm-task/Taskfile.yml
470492
npm:validate:
471-
desc: Validate npm configuration files against their JSON schema
493+
desc: |
494+
Validate npm configuration files against their JSON schema.
495+
Environment variable parameters:
496+
- PROJECT_PATH: Path of the npm-managed project (default: {{.DEFAULT_NPM_PROJECT_PATH}}).
472497
vars:
473498
# Source: https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/package.json
474499
SCHEMA_URL: https://json.schemastore.org/package.json
@@ -632,11 +657,12 @@ tasks:
632657
flake8 \
633658
--show-source
634659
635-
# Parameter variables:
636-
# - SCRIPT_PATH: path of the script to be checked.
637660
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-shell-task/Taskfile.yml
638661
shell:check:
639-
desc: Check for problems with shell scripts
662+
desc: |
663+
Check for problems with shell scripts.
664+
Environment variable parameters:
665+
- SCRIPT_PATH: path of the script to be checked.
640666
cmds:
641667
- |
642668
if [[ "{{.SCRIPT_PATH}}" == "" ]]; then
@@ -655,11 +681,12 @@ tasks:
655681
--format={{default "tty" .SHELLCHECK_FORMAT}} \
656682
"{{.SCRIPT_PATH}}"
657683
658-
# Parameter variables:
659-
# - SCRIPT_PATH: path of the script to be checked.
660684
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-shell-task/Taskfile.yml
661685
shell:check-mode:
662-
desc: Check for non-executable shell scripts
686+
desc: |
687+
Check for non-executable shell scripts.
688+
Environment variable parameters:
689+
- SCRIPT_PATH: path of the script to be checked.
663690
cmds:
664691
- |
665692
if [[ "{{.SCRIPT_PATH}}" == "" ]]; then
@@ -670,11 +697,12 @@ tasks:
670697
- |
671698
test -x "{{.SCRIPT_PATH}}"
672699
673-
# Parameter variables:
674-
# - SCRIPT_PATH: path of the script to be formatted.
675700
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-shell-task/Taskfile.yml
676701
shell:format:
677-
desc: Format shell script files
702+
desc: |
703+
Format shell script files.
704+
Environment variable parameters:
705+
- SCRIPT_PATH: path of the script to be formatted.
678706
cmds:
679707
- |
680708
if [[ "{{.SCRIPT_PATH}}" == "" ]]; then
@@ -689,7 +717,9 @@ tasks:
689717
fi
690718
- shfmt -w "{{.SCRIPT_PATH}}"
691719

692-
# Make a temporary file named according to the passed TEMPLATE variable and print the path passed to stdout
720+
# Make a temporary file and print the path passed to stdout.
721+
# Environment variable parameters:
722+
# - TEMPLATE: template for the format of the filename.
693723
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/windows-task/Taskfile.yml
694724
utility:mktemp-file:
695725
vars:
@@ -711,7 +741,9 @@ tasks:
711741
vars:
712742
RAW_PATH: "{{.RAW_PATH}}"
713743

714-
# Print a normalized version of the path passed via the RAW_PATH variable to stdout
744+
# Print a normalized version of the path to stdout.
745+
# Environment variable parameters:
746+
# - RAW_PATH: the path to be normalized.
715747
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/windows-task/Taskfile.yml
716748
utility:normalize-path:
717749
cmds:

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /