goyek v0.3.0 Release Notes
Release Date: 2021-05-03 // almost 3 years ago-
The repository has been migrated from https://github.com/pellared/taskflow to https://github.com/goyek/goyek.
๐ This release contains multiple breaking changes for both the CLI and the Go API.
The biggest change is a redesign of the parameters API, so they have to be explicitly registered. ๐ It makes the usage of the parameters more controlled and provides a better help output. Moreover, the parameters are set via CLI using the flag syntax.
โ Added
- ๐จ Help is printed when
-h
,--help
orhelp
is passed. - Help contains parameters' information.
- The tasks and parameters can be passed via CLI in any order.
Taskflow.Run
handlesnil
passed ascontext.Context
argument.Taskflow.Run
panics when a registered parameter is not assigned to any task.
๐ Changed
- Module path changed from
github.com/pellared/taskflow
togithub.com/goyek/goyek
. - ๐ฆ Rename package
task
togoyek
. - ๐ Use the flag syntax for setting parameters via CLI.
- ๐ Rename
Task.Description
field toUsage
. - ๐ Rename
Task.Dependencies
field toDeps
. - ๐ Rename
CodeFailure
constant toCodeFail
. - ๐ Rename
Taskflow.MustRegister
method toRegister
and remove previousTaskflow.Register
implementation. - โ Remove
Taskflow.Params
field andTF.Params
method, addTaskflow.Register*Param
methods andTask.Params
field instead. - โ Remove
TF.Verbose
, addTaskflow.VerboseParam
instead. - โ
Unexport
Runner
type, useTaskflow
in tests instead. - Enforce patterns for task names (
TaskNamePattern
) and parameter names (ParamNamePattern
).
โ Removed
- โ Remove
New
function, create instance using&Taskflow{}
instead. - โฌ๏ธ Drop official support for Go 1.10.
- ๐จ Help is printed when