Changelog

This project adheres to Semantic Versioning.

Unreleased

0.7.1 (2024-08-07)

Fixed

Updated go releaser action with necessary permissions.

0.7.0 (2024-08-07)

Added

Arguments may now specify a type, which works the same way as options.
Boolean options may now be rewritten into strings using rewrite.
Environment variables are now automatically parsed from .env files.
Additional environment variable files can be specified with env-file.

Fixed

Arguments and options are now properly validated when passed to sub-tasks.
Short names may no longer be provided for private options.

0.6.4 (2022-09-27)

Added

Installation with go install is now officially supported.

Fixed

Improved handling of colons in bash completion.

0.6.3 (2022-02-16)

Added

The quiet clause is now available for commands and tasks to quiet additional logging.

0.6.2 (2021-04-26)

Added

Added fish completions.

Fixed

Fixed an issue where certain behavior might unintentionally run during tab completions.
Fixed an issue where XDG_DATA_HOME was respected incorrectly when installing bash completions.

0.6.1 (2020-08-17)

Added

Commands to install and uninstall completion will now appear in the help documentation.

0.6.0 (2020-05-16)

Added

The interpreter used for running commands can now be configured using the top-level interpreter clause in the YAML configuration.

Changed

The interpreter now allows for specifying an arbitrary command and series of arguments, so interpreters like node or ruby that happen to use a flag other than -c may be specified.
The interpreter settings now also apply to commands run as part of when and option clauses.

Removed

BREAKING: To avoid inadvertantly picking up unrelated shell settings, the environment variable SHELL is no longer considered an override for the command interpreter.

0.5.2 (2020-01-26)

Added

The include clause is now available to include task definitions from other files.

0.5.1 (2020-01-13)

Fixed

Completions now correctly escape ":" characters in command and flag names.

0.5.0 (2019-12-05)

Added

The command clause now accepts a print option to override the command text that is printed to screen.
The command clause now acccepts a dir option to change the working directory for that command.

Changed

The command clause now has a longer form, where string literals now map to the exec field. This longer form allows additional options such as print to be specified in a command when necessary while maintaining backward compatibility.

Fixed

BREAKING: Unspecified fields in the YAML or duplicate map keys should more consistently raise errors when parsing. Some tusk.yml files with issues that were treated as valid in previous versions may no longer be considered valid.

Removed

BREAKING: Setting environment variables with environment has been removed in favor of set-environment.

0.4.7 (2019-08-06)

Fixed

Fix issue where args could be passed to tasks out of order.

0.4.6 (2019-06-30)

Added

Support Alpine Linux with binary releases.

0.4.5 (2019-05-05)

Added

Support not-exists check inside when clauses.

0.4.4 (2019-04-24)

Added

Bash and zsh completion can be installed and uninstalled by command-line.

0.4.3 (2019-03-31)

Added

Help text for commands now includes arguments section.
Include subtask hierarchy on command run.

Changed

UI theme is now slightly more colorful.
Hidden task names do not appear in console output.

0.4.2 (2019-01-23)

Added

Add short form for when clauses to express equal-true relationships.

0.4.1 (2018-07-03)

Added

Add finally clause to run cleanup logic after tasks have completed. This clause takes the same arguments as run.

Changed

Update UI theme to include more relevant information in normal and verbose modes.

0.4.0 (2018-05-21)

Added

Short-flag combination is now supported.

Changed

A when item now evaluates to true if ANY tests pass rather than if ALL tests pass. All when items in a clause must still pass.
environment clauses in when items now support mapping a single key to multiple values.

Removed

BREAKING: Remove deprecated not_equal syntax in favor of not-equal.

0.3.5 (2018-04-11)

Added

Positional arguments for tasks are now supported. All positional arguments specified in the config file are required.

Changed

Tagline is now "the modern task runner".
Help documentation for flags with placeholder options now display them using angular brackets.
Minor changes to certain error messages.

0.3.4 (2018-03-14)

Added

Top-level keys name and usage can be changed in the config file to update help documentation. This supports aliasing different config files to be used as custom CLI tools.
Support tusk.yaml as alternate config file name.

0.3.3 (2018-02-21)

Added

Support environment variable conditional in when clauses.

Changed

Warnings now appear more consistently for deprecated functionality.
Help documentation for flags is now more consistently structured.
Several configuration keys have been renamed. While the original names are still supported, they have been deprecated and will be removed in a future release. See the deprecated section for details.

Deprecated

The key name not_equal should be replaced with not-equal. This change is to reinforce the convention for naming multi-word keys such as flag names using kebab case.
The key name environment in run clauses should be replaced with set-environment. This is to make the behavior distinction from other environment clauses clear.

0.3.2 (2018-01-23)

Added

Support lists of when items.

Deprecated

Individual when items should no longer contain multiple validations for AND logic. Multiple validations for OR logic will be added in a future release.

0.3.1 (2018-01-05)

Fixed

Invoking the same sub-task multiple times with different options now assigns the options to each sub-task correctly.
Short flags with arguments now offer Bash/Zsh completions correctly.

0.3.0 (2018-01-04)

Changed

BREAKING: Interpolation is now done per task. This has the following effects:
- Sub-task options are no longer exposed to the command line.
- Sub-task options are now exposed in run clauses and can be passed by a parent task to a sub-task.
- Shared options are only exposed when used directly by the invoked task and not when invoked by sub-tasks.
- Tasks and sub-tasks can define options with the same name.
Sub-tasks can now be defined in any order.

Fixed

Sub-tasks no longer execute multiple times per reference in situations where the same sub-task is referenced in multiple places.

Removed

BREAKING: Environment variables can no longer be set inside of an option clause. Using environment inside a run clause is the replacement behavior.

0.2.3 (2017-12-19)

Fixed

Fix issue with Zsh tab completions.

0.2.2 (2017-12-14)

Added

Add values field for options. Any option directly passed by command line flag or environment variable must be one of the listed values, if specified.
Add completion for option values.

Fixed

Fix issue where global flags with hyphens are sometimes skipped during interpolation.
Fix various issues with Zsh tab completions.

0.2.1 (2017-11-12)

Added

Environment variables can now be set and unset inside of a run clause. This replaces the export functionality that was previously under option.
Tasks can now be defined as private.

Changed

Change to more minimalistic UI output theme.
Log-level messages (Debug, Info, Warning, and Error) are now printed in title case instead of all caps.

Deprecated

Environment variables should no longer be set inside of an option clause. Using environment inside a run clause is the replacement behavior.

0.2.0 (2017-11-08)

Added

Windows is now supported.
New -s/--silent global option available for no stderr/stdout.

Changed

BREAKING: Shell commands are now executed by the SHELL environment variable by default. If SHELL is not set, sh is used.
Commands and flags are now listed in alphabetical order.

Fixed

Avoid infinite loop when searching for tusk.yml in non-unix file systems.
Remove redundant error message for non-exit exec errors.
Improve error messaging for non-generic yaml parsing errors.
Fix indentation for the task list in --help output.

0.1.5 (2017-10-26)

Changed

Include expected value for skipped run clauses during verbose logging.

Fixed

Bash and Zsh completions offer file completion for subcommand flags that take a value rather than re-offering flag names.
The default value for numeric types is now 0, and the default for booleans is now false. Previously, it was an empty string for both.

0.1.4 (2017-10-19)

Changed

Bash and Zsh completions now complete global flags and task flags.
Zsh completion now includes usage information.

Fixed

Application no longer errors when referencing the same shared option in both a task and its sub-task. Redefinitions are still disallowed.

0.1.3 (2017-10-16)

Added

Completions for Bash and Zsh are now bundled with releases and automatically installed with Homebrew.
Homepage is now listed for Homebrew formula.

Changed

Help documentation is no longer displayed during incorrect usage.

Fixed

Passing the help flag now prevents code execution and prints help.
Homebrew test command is now functional.

0.1.2 (2017-09-26)

Added

Options may now be required.
Options can be exported to environment variables.

Changed

Improve error handling in custom yaml unmarshaling.
Exit for unexpected errors occuring during when clause validation.
Use exit code 1 for all unexpected errors.
Unexpected arguments now cause an error.
Remove piping of command stdout/stderr to improve support for interactive tasks.

Fixed

Short names cannot exceed one character in length.

0.1.1 (2017-09-16)

Changed

The recommended way to install the latest stable version is now Homebrew or downloading directly from the GitHub releases page.

Fixed

Fix interpolation for tasks with only private options.

0.1.0 (2017-09-14)

Initial Release