@@ -289,14 +289,22 @@ tasks:
289
289
290
290
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
291
291
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).
293
297
dir : " {{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
294
298
cmds :
295
299
- go fix {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
296
300
297
301
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
298
302
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).
300
308
dir : " {{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
301
309
cmds :
302
310
- go fmt {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
@@ -313,7 +321,11 @@ tasks:
313
321
314
322
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
315
323
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).
317
329
dir : " {{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
318
330
cmds :
319
331
- |
@@ -378,7 +390,10 @@ tasks:
378
390
379
391
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
380
392
go:tidy :
381
- 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}}).
382
397
dir : " {{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
383
398
vars :
384
399
GO_VERSION : 1.24.0
@@ -387,7 +402,11 @@ tasks:
387
402
388
403
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-go-task/Taskfile.yml
389
404
go:vet :
390
- 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).
391
410
dir : " {{default .DEFAULT_GO_MODULE_PATH .GO_MODULE_PATH}}"
392
411
cmds :
393
412
- go vet {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
@@ -458,21 +477,23 @@ tasks:
458
477
markdownlint-cli \
459
478
"**/*.md"
460
479
461
- # Parameter variables:
462
- # - PROJECT_PATH: path of the npm-managed project. Default value: "./"
463
480
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/npm-task/Taskfile.yml
464
481
npm:install-deps :
465
- 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}}).
466
486
dir : |
467
487
"{{default .DEFAULT_NPM_PROJECT_PATH .PROJECT_PATH}}"
468
488
cmds :
469
489
- npm install
470
490
471
- # Parameter variables:
472
- # - PROJECT_PATH: path of the npm-managed project. Default value: "./"
473
491
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-npm-task/Taskfile.yml
474
492
npm:validate :
475
- 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}}).
476
497
vars :
477
498
# Source: https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/package.json
478
499
SCHEMA_URL : https://json.schemastore.org/package.json
@@ -636,11 +657,12 @@ tasks:
636
657
flake8 \
637
658
--show-source
638
659
639
- # Parameter variables:
640
- # - SCRIPT_PATH: path of the script to be checked.
641
660
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-shell-task/Taskfile.yml
642
661
shell:check :
643
- 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.
644
666
cmds :
645
667
- |
646
668
if [[ "{{.SCRIPT_PATH}}" == "" ]]; then
@@ -659,11 +681,12 @@ tasks:
659
681
--format={{default "tty" .SHELLCHECK_FORMAT}} \
660
682
"{{.SCRIPT_PATH}}"
661
683
662
- # Parameter variables:
663
- # - SCRIPT_PATH: path of the script to be checked.
664
684
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-shell-task/Taskfile.yml
665
685
shell:check-mode :
666
- 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.
667
690
cmds :
668
691
- |
669
692
if [[ "{{.SCRIPT_PATH}}" == "" ]]; then
@@ -674,11 +697,12 @@ tasks:
674
697
- |
675
698
test -x "{{.SCRIPT_PATH}}"
676
699
677
- # Parameter variables:
678
- # - SCRIPT_PATH: path of the script to be formatted.
679
700
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-shell-task/Taskfile.yml
680
701
shell:format :
681
- 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.
682
706
cmds :
683
707
- |
684
708
if [[ "{{.SCRIPT_PATH}}" == "" ]]; then
0 commit comments