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 or help is passed.
    • Help contains parameters' information.
    • The tasks and parameters can be passed via CLI in any order.
    • Taskflow.Run handles nil passed as context.Context argument.
    • Taskflow.Run panics when a registered parameter is not assigned to any task.

    ๐Ÿ”„ Changed

    • Module path changed from github.com/pellared/taskflow to github.com/goyek/goyek.
    • ๐Ÿ“ฆ Rename package task to goyek.
    • ๐Ÿ‘‰ Use the flag syntax for setting parameters via CLI.
    • ๐Ÿ“‡ Rename Task.Description field to Usage.
    • ๐Ÿ“‡ Rename Task.Dependencies field to Deps.
    • ๐Ÿ“‡ Rename CodeFailure constant to CodeFail.
    • ๐Ÿ“‡ Rename Taskflow.MustRegister method to Register and remove previous Taskflow.Register implementation.
    • โœ‚ Remove Taskflow.Params field and TF.Params method, add Taskflow.Register*Param methods and Task.Params field instead.
    • โœ‚ Remove TF.Verbose, add Taskflow.VerboseParam instead.
    • โœ… Unexport Runner type, use Taskflow 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.