go/task
go/task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2024-12-04 10:24:45 +02:00
Code Issues Releases Activity

fix: typos in docs, changelog, testdata, comments (#1910)

Browse Source
This commit is contained in:
Oleksandr Redko 2024-11-07 18:25:59 +02:00 committed by GitHub
parent c3bd6b9384
commit 390220ec9c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CHANGELOG.md
View File

@ -292,7 +292,7 @@
- Added the - Added the
[Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles)
as a draft (#1152, #1317 by @pd93). as a draft (#1152, #1317 by @pd93).
- Improve performance of content checksuming on `sources:` by replacing md5 with - Improve performance of content checksumming on `sources:` by replacing md5 with
[XXH3](https://xxhash.com/) which is much faster. This is a soft breaking [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking
change because checksums will be invalidated when upgrading to this release change because checksums will be invalidated when upgrading to this release
(#1325 by @ReillyBrogan). (#1325 by @ReillyBrogan).
@ -352,7 +352,7 @@
- Deprecated `version: 2` schema. This will be removed in the next major release - Deprecated `version: 2` schema. This will be removed in the next major release
(#1197, #1198, #1199 by @pd93). (#1197, #1198, #1199 by @pd93).
- Added a new `prompt:` prop to set a warning prompt to be shown before running - Added a new `prompt:` prop to set a warning prompt to be shown before running
a potential dangurous task (#100, #1163 by @MaxCheetham, a potential dangerous task (#100, #1163 by @MaxCheetham,
[Documentation](https://taskfile.dev/usage/#warning-prompts)). [Documentation](https://taskfile.dev/usage/#warning-prompts)).
- Added support for single command task syntax. With this change, it's now - Added support for single command task syntax. With this change, it's now
possible to declare just `cmd:` in a task, avoiding the more complex possible to declare just `cmd:` in a task, avoiding the more complex
@ -367,7 +367,7 @@
percentage (#1173 by @misitebao). percentage (#1173 by @misitebao).
- Starting on this release, official binaries for FreeBSD will be available to - Starting on this release, official binaries for FreeBSD will be available to
download (#1068 by @andreynering). download (#1068 by @andreynering).
- Fix some errors being unintendedly supressed (#1134 by @clintmod). - Fix some errors being unintendedly suppressed (#1134 by @clintmod).
- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - Fix a nil pointer error when `version` is omitted from a Taskfile (#1148,
#1149 by @pd93). #1149 by @pd93).
- Fix duplicate error message when a task does not exists (#1141, #1144 by - Fix duplicate error message when a task does not exists (#1141, #1144 by
@ -441,7 +441,7 @@ it a go and let us know what you think via a
by @pd93). by @pd93).
- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) - Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93)
- Added environment variable `FORCE_COLOR` support to force color output. - Added environment variable `FORCE_COLOR` support to force color output.
Usefull for environments without TTY (#1003 by @automation-stack) Useful for environments without TTY (#1003 by @automation-stack)
## v3.20.0 - 2023-01-14 ## v3.20.0 - 2023-01-14
@ -796,7 +796,7 @@ it a go and let us know what you think via a
- Fix error code for the `--help` flag (#300, #330). - Fix error code for the `--help` flag (#300, #330).
- Print version to stdout instead of stderr (#299, #329). - Print version to stdout instead of stderr (#299, #329).
- Supress `context` errors when using the `--watch` flag (#313, #317). - Suppress `context` errors when using the `--watch` flag (#313, #317).
- Support templating on description (#276, #283). - Support templating on description (#276, #283).
## v2.8.0 - 2019-12-07 ## v2.8.0 - 2019-12-07
@ -805,7 +805,7 @@ it a go and let us know what you think via a
parallel (#266). parallel (#266).
- Fixed bug where calling the `task` CLI only informing global vars would not - Fixed bug where calling the `task` CLI only informing global vars would not
execute the `default` task. execute the `default` task.
- Add hability to silent all tasks by adding `silent: true` a the root of the - Add ability to silent all tasks by adding `silent: true` a the root of the
Taskfile. Taskfile.
## v2.7.1 - 2019-11-10 ## v2.7.1 - 2019-11-10
@ -947,7 +947,7 @@ document, since it describes in depth what changed for this version.
## v1.4.3 - 2017-09-07 ## v1.4.3 - 2017-09-07
- Allow assigning variables to tasks at run time via CLI (#33) - Allow assigning variables to tasks at run time via CLI (#33)
- Added suport for multiline variables from sh (#64) - Added support for multiline variables from sh (#64)
- Fixes env: remove square braces and evaluate shell (#62) - Fixes env: remove square braces and evaluate shell (#62)
- Watch: change watch library and few fixes and improvements - Watch: change watch library and few fixes and improvements
- When use watching, cancel and restart long running process on file change (#59 - When use watching, cancel and restart long running process on file change (#59
@ -1007,7 +1007,7 @@ document, since it describes in depth what changed for this version.
- More tests and Travis integration - More tests and Travis integration
- Watch a task (experimental) - Watch a task (experimental)
- Possibility to call another task - Possibility to call another task
- Fix "=" not being reconized in variables/environment variables - Fix "=" not being recognized in variables/environment variables
- Tasks can now have a description, and help will print them (#10) - Tasks can now have a description, and help will print them (#10)
- Task dependencies now run concurrently - Task dependencies now run concurrently
- Support for a default task (#16) - Support for a default task (#16)

2
cmd/sleepit/sleepit.go
View File

@ -159,7 +159,7 @@ func worker(
return workerDone return workerDone
} }
// Do some work and then return, so that the caller can decide wether to continue or not. // Do some work and then return, so that the caller can decide whether to continue or not.
// Return true when all work is done. // Return true when all work is done.
func doSomeWork(deadline time.Time) bool { func doSomeWork(deadline time.Time) bool {
if time.Now().After(deadline) { if time.Now().After(deadline) {

2
internal/compiler/compiler.go
View File

@ -175,7 +175,7 @@ func (c *Compiler) HandleDynamicVar(v ast.Var, dir string) (string, error) {
return result, nil return result, nil
} }
// ResetCache clear the dymanic variables cache // ResetCache clear the dynamic variables cache
func (c *Compiler) ResetCache() { func (c *Compiler) ResetCache() {
c.muDynamicCache.Lock() c.muDynamicCache.Lock()
defer c.muDynamicCache.Unlock() defer c.muDynamicCache.Unlock()

8
task_test.go
View File

@ -121,9 +121,9 @@ func TestEnv(t *testing.T) {
TrimSpace: false, TrimSpace: false,
Files: map[string]string{ Files: map[string]string{
"local.txt": "GOOS='linux' GOARCH='amd64' CGO_ENABLED='0'\n", "local.txt": "GOOS='linux' GOARCH='amd64' CGO_ENABLED='0'\n",
"global.txt": "FOO='foo' BAR='overriden' BAZ='baz'\n", "global.txt": "FOO='foo' BAR='overridden' BAZ='baz'\n",
"multiple_type.txt": "FOO='1' BAR='true' BAZ='1.1'\n", "multiple_type.txt": "FOO='1' BAR='true' BAZ='1.1'\n",
"not-overriden.txt": "QUX='from_os'\n", "not-overridden.txt": "QUX='from_os'\n",
}, },
} }
tt.Run(t) tt.Run(t)
@ -131,10 +131,10 @@ func TestEnv(t *testing.T) {
experiments.EnvPrecedence = experiments.New("ENV_PRECEDENCE") experiments.EnvPrecedence = experiments.New("ENV_PRECEDENCE")
ttt := fileContentTest{ ttt := fileContentTest{
Dir: "testdata/env", Dir: "testdata/env",
Target: "overriden", Target: "overridden",
TrimSpace: false, TrimSpace: false,
Files: map[string]string{ Files: map[string]string{
"overriden.txt": "QUX='from_taskfile'\n", "overridden.txt": "QUX='from_taskfile'\n",
}, },
} }
ttt.Run(t) ttt.Run(t)

12
testdata/env/Taskfile.yml vendored
View File

@ -15,7 +15,7 @@ tasks:
cmds: cmds:
- task: local - task: local
- task: global - task: global
- task: not-overriden - task: not-overridden
- task: multiple_type - task: multiple_type
local: local:
@ -31,7 +31,7 @@ tasks:
global: global:
env: env:
BAR: overriden BAR: overridden
cmds: cmds:
- echo "FOO='$FOO' BAR='$BAR' BAZ='$BAZ'" > global.txt - echo "FOO='$FOO' BAR='$BAR' BAZ='$BAZ'" > global.txt
@ -43,10 +43,10 @@ tasks:
cmds: cmds:
- echo "FOO='$FOO' BAR='$BAR' BAZ='$BAZ'" > multiple_type.txt - echo "FOO='$FOO' BAR='$BAR' BAZ='$BAZ'" > multiple_type.txt
not-overriden: not-overridden:
cmds: cmds:
- echo "QUX='$QUX'" > not-overriden.txt - echo "QUX='$QUX'" > not-overridden.txt
overriden: overridden:
cmds: cmds:
- echo "QUX='$QUX'" > overriden.txt - echo "QUX='$QUX'" > overridden.txt

2
testdata/exit_immediately/Taskfile.yml vendored
View File

@ -3,4 +3,4 @@ version: '3'
tasks: tasks:
default: | default: |
this_should_fail this_should_fail
echo "This shoudn't be print" echo "This shouldn't be print"

10
testdata/summary/Taskfile.yml vendored
View File

@ -2,7 +2,7 @@ version: '3'
tasks: tasks:
task-with-summary: task-with-summary:
deps: [dependend-task-1, dependend-task-2] deps: [dependent-task-1, dependent-task-2]
summary: | summary: |
summary of task-with-summary - line 1 summary of task-with-summary - line 1
line 2 line 2
@ -17,10 +17,10 @@ tasks:
cmds: cmds:
- echo 'other-task-with-summary was executed' - echo 'other-task-with-summary was executed'
dependend-task-1: dependent-task-1:
cmds: cmds:
- echo 'dependend-task-1 was executed' - echo 'dependent-task-1 was executed'
dependend-task-2: dependent-task-2:
cmds: cmds:
- echo 'dependend-task-2 was executed' - echo 'dependent-task-2 was executed'

4
testdata/summary/task-with-summary.txt vendored
View File

@ -5,8 +5,8 @@ line 2
line 3 line 3
dependencies: dependencies:
- dependend-task-1 - dependent-task-1
- dependend-task-2 - dependent-task-2
commands: commands:
- echo 'task-with-summary was executed' - echo 'task-with-summary was executed'

16
website/docs/changelog.mdx
View File

@ -297,7 +297,7 @@ sidebar_position: 14
- Added the - Added the
[Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles)
as a draft (#1152, #1317 by @pd93). as a draft (#1152, #1317 by @pd93).
- Improve performance of content checksuming on `sources:` by replacing md5 with - Improve performance of content checksumming on `sources:` by replacing md5 with
[XXH3](https://xxhash.com/) which is much faster. This is a soft breaking [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking
change because checksums will be invalidated when upgrading to this release change because checksums will be invalidated when upgrading to this release
(#1325 by @ReillyBrogan). (#1325 by @ReillyBrogan).
@ -357,7 +357,7 @@ sidebar_position: 14
- Deprecated `version: 2` schema. This will be removed in the next major release - Deprecated `version: 2` schema. This will be removed in the next major release
(#1197, #1198, #1199 by @pd93). (#1197, #1198, #1199 by @pd93).
- Added a new `prompt:` prop to set a warning prompt to be shown before running - Added a new `prompt:` prop to set a warning prompt to be shown before running
a potential dangurous task (#100, #1163 by @MaxCheetham, a potential dangerous task (#100, #1163 by @MaxCheetham,
[Documentation](https://taskfile.dev/usage/#warning-prompts)). [Documentation](https://taskfile.dev/usage/#warning-prompts)).
- Added support for single command task syntax. With this change, it's now - Added support for single command task syntax. With this change, it's now
possible to declare just `cmd:` in a task, avoiding the more complex possible to declare just `cmd:` in a task, avoiding the more complex
@ -372,7 +372,7 @@ sidebar_position: 14
percentage (#1173 by @misitebao). percentage (#1173 by @misitebao).
- Starting on this release, official binaries for FreeBSD will be available to - Starting on this release, official binaries for FreeBSD will be available to
download (#1068 by @andreynering). download (#1068 by @andreynering).
- Fix some errors being unintendedly supressed (#1134 by @clintmod). - Fix some errors being unintendedly suppressed (#1134 by @clintmod).
- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - Fix a nil pointer error when `version` is omitted from a Taskfile (#1148,
#1149 by @pd93). #1149 by @pd93).
- Fix duplicate error message when a task does not exists (#1141, #1144 by - Fix duplicate error message when a task does not exists (#1141, #1144 by
@ -446,7 +446,7 @@ it a go and let us know what you think via a
by @pd93). by @pd93).
- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) - Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93)
- Added environment variable `FORCE_COLOR` support to force color output. - Added environment variable `FORCE_COLOR` support to force color output.
Usefull for environments without TTY (#1003 by @automation-stack) Useful for environments without TTY (#1003 by @automation-stack)
## v3.20.0 - 2023-01-14 ## v3.20.0 - 2023-01-14
@ -801,7 +801,7 @@ it a go and let us know what you think via a
- Fix error code for the `--help` flag (#300, #330). - Fix error code for the `--help` flag (#300, #330).
- Print version to stdout instead of stderr (#299, #329). - Print version to stdout instead of stderr (#299, #329).
- Supress `context` errors when using the `--watch` flag (#313, #317). - Suppress `context` errors when using the `--watch` flag (#313, #317).
- Support templating on description (#276, #283). - Support templating on description (#276, #283).
## v2.8.0 - 2019-12-07 ## v2.8.0 - 2019-12-07
@ -810,7 +810,7 @@ it a go and let us know what you think via a
parallel (#266). parallel (#266).
- Fixed bug where calling the `task` CLI only informing global vars would not - Fixed bug where calling the `task` CLI only informing global vars would not
execute the `default` task. execute the `default` task.
- Add hability to silent all tasks by adding `silent: true` a the root of the - Add ability to silent all tasks by adding `silent: true` a the root of the
Taskfile. Taskfile.
## v2.7.1 - 2019-11-10 ## v2.7.1 - 2019-11-10
@ -952,7 +952,7 @@ document, since it describes in depth what changed for this version.
## v1.4.3 - 2017-09-07 ## v1.4.3 - 2017-09-07
- Allow assigning variables to tasks at run time via CLI (#33) - Allow assigning variables to tasks at run time via CLI (#33)
- Added suport for multiline variables from sh (#64) - Added support for multiline variables from sh (#64)
- Fixes env: remove square braces and evaluate shell (#62) - Fixes env: remove square braces and evaluate shell (#62)
- Watch: change watch library and few fixes and improvements - Watch: change watch library and few fixes and improvements
- When use watching, cancel and restart long running process on file change (#59 - When use watching, cancel and restart long running process on file change (#59
@ -1012,7 +1012,7 @@ document, since it describes in depth what changed for this version.
- More tests and Travis integration - More tests and Travis integration
- Watch a task (experimental) - Watch a task (experimental)
- Possibility to call another task - Possibility to call another task
- Fix "=" not being reconized in variables/environment variables - Fix "=" not being recognized in variables/environment variables
- Tasks can now have a description, and help will print them (#10) - Tasks can now have a description, and help will print them (#10)
- Task dependencies now run concurrently - Task dependencies now run concurrently
- Support for a default task (#16) - Support for a default task (#16)

2
website/docs/usage.mdx
View File

@ -1212,7 +1212,7 @@ tasks:
- echo "{{.GREETING}}" - echo "{{.GREETING}}"
``` ```
Example of a `default` value to be overriden from CLI: Example of a `default` value to be overridden from CLI:
```yaml ```yaml
version: '3' version: '3'

16
website/versioned_docs/version-latest/changelog.mdx
View File

@ -297,7 +297,7 @@ sidebar_position: 14
- Added the - Added the
[Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles) [Remote Taskfiles experiment](https://taskfile.dev/experiments/remote-taskfiles)
as a draft (#1152, #1317 by @pd93). as a draft (#1152, #1317 by @pd93).
- Improve performance of content checksuming on `sources:` by replacing md5 with - Improve performance of content checksumming on `sources:` by replacing md5 with
[XXH3](https://xxhash.com/) which is much faster. This is a soft breaking [XXH3](https://xxhash.com/) which is much faster. This is a soft breaking
change because checksums will be invalidated when upgrading to this release change because checksums will be invalidated when upgrading to this release
(#1325 by @ReillyBrogan). (#1325 by @ReillyBrogan).
@ -357,7 +357,7 @@ sidebar_position: 14
- Deprecated `version: 2` schema. This will be removed in the next major release - Deprecated `version: 2` schema. This will be removed in the next major release
(#1197, #1198, #1199 by @pd93). (#1197, #1198, #1199 by @pd93).
- Added a new `prompt:` prop to set a warning prompt to be shown before running - Added a new `prompt:` prop to set a warning prompt to be shown before running
a potential dangurous task (#100, #1163 by @MaxCheetham, a potential dangerous task (#100, #1163 by @MaxCheetham,
[Documentation](https://taskfile.dev/usage/#warning-prompts)). [Documentation](https://taskfile.dev/usage/#warning-prompts)).
- Added support for single command task syntax. With this change, it's now - Added support for single command task syntax. With this change, it's now
possible to declare just `cmd:` in a task, avoiding the more complex possible to declare just `cmd:` in a task, avoiding the more complex
@ -372,7 +372,7 @@ sidebar_position: 14
percentage (#1173 by @misitebao). percentage (#1173 by @misitebao).
- Starting on this release, official binaries for FreeBSD will be available to - Starting on this release, official binaries for FreeBSD will be available to
download (#1068 by @andreynering). download (#1068 by @andreynering).
- Fix some errors being unintendedly supressed (#1134 by @clintmod). - Fix some errors being unintendedly suppressed (#1134 by @clintmod).
- Fix a nil pointer error when `version` is omitted from a Taskfile (#1148, - Fix a nil pointer error when `version` is omitted from a Taskfile (#1148,
#1149 by @pd93). #1149 by @pd93).
- Fix duplicate error message when a task does not exists (#1141, #1144 by - Fix duplicate error message when a task does not exists (#1141, #1144 by
@ -446,7 +446,7 @@ it a go and let us know what you think via a
by @pd93). by @pd93).
- Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93) - Update to Go 1.20 (bump minimum version to 1.19) (#1010 by @pd93)
- Added environment variable `FORCE_COLOR` support to force color output. - Added environment variable `FORCE_COLOR` support to force color output.
Usefull for environments without TTY (#1003 by @automation-stack) Useful for environments without TTY (#1003 by @automation-stack)
## v3.20.0 - 2023-01-14 ## v3.20.0 - 2023-01-14
@ -801,7 +801,7 @@ it a go and let us know what you think via a
- Fix error code for the `--help` flag (#300, #330). - Fix error code for the `--help` flag (#300, #330).
- Print version to stdout instead of stderr (#299, #329). - Print version to stdout instead of stderr (#299, #329).
- Supress `context` errors when using the `--watch` flag (#313, #317). - Suppress `context` errors when using the `--watch` flag (#313, #317).
- Support templating on description (#276, #283). - Support templating on description (#276, #283).
## v2.8.0 - 2019-12-07 ## v2.8.0 - 2019-12-07
@ -810,7 +810,7 @@ it a go and let us know what you think via a
parallel (#266). parallel (#266).
- Fixed bug where calling the `task` CLI only informing global vars would not - Fixed bug where calling the `task` CLI only informing global vars would not
execute the `default` task. execute the `default` task.
- Add hability to silent all tasks by adding `silent: true` a the root of the - Add ability to silent all tasks by adding `silent: true` a the root of the
Taskfile. Taskfile.
## v2.7.1 - 2019-11-10 ## v2.7.1 - 2019-11-10
@ -952,7 +952,7 @@ document, since it describes in depth what changed for this version.
## v1.4.3 - 2017-09-07 ## v1.4.3 - 2017-09-07
- Allow assigning variables to tasks at run time via CLI (#33) - Allow assigning variables to tasks at run time via CLI (#33)
- Added suport for multiline variables from sh (#64) - Added support for multiline variables from sh (#64)
- Fixes env: remove square braces and evaluate shell (#62) - Fixes env: remove square braces and evaluate shell (#62)
- Watch: change watch library and few fixes and improvements - Watch: change watch library and few fixes and improvements
- When use watching, cancel and restart long running process on file change (#59 - When use watching, cancel and restart long running process on file change (#59
@ -1012,7 +1012,7 @@ document, since it describes in depth what changed for this version.
- More tests and Travis integration - More tests and Travis integration
- Watch a task (experimental) - Watch a task (experimental)
- Possibility to call another task - Possibility to call another task
- Fix "=" not being reconized in variables/environment variables - Fix "=" not being recognized in variables/environment variables
- Tasks can now have a description, and help will print them (#10) - Tasks can now have a description, and help will print them (#10)
- Task dependencies now run concurrently - Task dependencies now run concurrently
- Support for a default task (#16) - Support for a default task (#16)

2
website/versioned_docs/version-latest/usage.mdx
View File

@ -1212,7 +1212,7 @@ tasks:
- echo "{{.GREETING}}" - echo "{{.GREETING}}"
``` ```
Example of a `default` value to be overriden from CLI: Example of a `default` value to be overridden from CLI:
```yaml ```yaml
version: '3' version: '3'