4.0 KiB
| slug | sidebar_position |
|---|---|
| /experiments/ | 5 |
Experiments
:::caution
All experimental features are subject to breaking changes and/or removal at any time. We strongly recommend that you do not use these features in a production environment. They are intended for testing and feedback only.
:::
In order to allow Task to evolve quickly, we roll out breaking changes to minor versions behind experimental flags. This allows us to gather feedback on breaking changes before committing to a major release. This document describes the current set of experimental features and the deprecated feature that they are intended to replace.
You can enable an experimental feature by:
- Using the relevant environment variable in front of a task command. For example,
TASK_X_{FEATURE}=1 task {my-task}. This is intended for one-off invocations of Task to test out experimental features. - Using the relevant environment variable in your "dotfiles" (e.g.
.bashrc,.zshrcetc.). This is intended for permanently enabling experimental features in your environment. - Creating a
.envfile in the same directory as your root Taskfile that contains the relevant environment variables. e.g.
# .env
TASK_X_FEATURE=1
Current Experimental Features and Deprecations
Each section below details an experiment or deprecation and explains what the flags/environment variables to enable the experiment are and how the feature's behavior will change. It will also explain what you need to do to migrate any existing Taskfiles to the new behavior.
Version 2 Schema (#1197)
The Taskfile v2 schema was introduced in March 2018 and replaced by version 3 in August the following year. Users have had a long time to update and so we feel that it is time to tidy up the codebase and focus on new functionality instead.
This notice does not mean that we are immediately removing support for version 2 schemas. However, support will not be extended to future major releases and we strongly recommend that anybody still using a version 2 schema upgrades to version 3 as soon as possible.
A list of changes between version 2 and version 3 are available in the Task v3 Release Notes.
Gentle Force (#1200)
- Environment variable:
TASK_X_FORCE=1 - Breaks:
--forceflag
The --force flag currently forces all tasks to run regardless of the status checks. This can be useful, but we have found that most of the time users only expect the direct task they are calling to be forced and not all of its dependant tasks.
This experiment changes the --force flag to only force the directly called task. All dependant tasks will have their statuses checked as normal and will only run if Task considers them to be out of date. A new --force-all flag will also be added to maintain the current behavior for users that need this functionality.
If you want to migrate, but continue to force all dependant tasks to run, you should replace all uses of the --force flag with --force-all. Alternatively, if you want to adopt the new behavior, you can continue to use the --force flag as you do now!