mirror of
https://github.com/go-task/task.git
synced 2025-08-10 22:42:19 +02:00
docs: add experiments doc and v2 deprecation notice
This commit is contained in:
committed by
Andrey Nering
parent
1a86c2c52d
commit
793c1e5587
@@ -19,7 +19,7 @@ const (
|
||||
|
||||
const changelogTemplate = `---
|
||||
slug: /changelog/
|
||||
sidebar_position: 8
|
||||
sidebar_position: 9
|
||||
---`
|
||||
|
||||
var (
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /changelog/
|
||||
sidebar_position: 8
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Changelog
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /community/
|
||||
sidebar_position: 9
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Community
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /contributing/
|
||||
sidebar_position: 10
|
||||
sidebar_position: 11
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /donate/
|
||||
sidebar_position: 13
|
||||
sidebar_position: 15
|
||||
---
|
||||
|
||||
# Donate
|
||||
|
74
docs/docs/experiments.md
Normal file
74
docs/docs/experiments.md
Normal file
@@ -0,0 +1,74 @@
|
||||
---
|
||||
slug: /experiments/
|
||||
sidebar_position: 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:
|
||||
|
||||
1. Using the `--x-<feature>` flag. This is intended for one-off invocations of
|
||||
Task to test out experimental features. You can also disable a feature by
|
||||
specifying a falsy value such as `--x-<feature>=false`.
|
||||
1. Using the `TASK_X_<FEATURE>=1` environment variable. This is intended for
|
||||
permanently enabling experimental features in your environment.
|
||||
|
||||
You can view the [full breaking changes proposal on
|
||||
GitHub][breaking-change-proposal].
|
||||
|
||||
## 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.
|
||||
|
||||
<!-- EXPERIMENT TEMPLATE - Include sections as necessary...
|
||||
|
||||
### ![experiment] <Feature> ([#<issue>](https://github.com/go-task/task/issues/<issue>)), ...)
|
||||
|
||||
- Flag to enable: `--x-<feature>`
|
||||
- Env to enable: `TASK_X_<feature>`
|
||||
- Deprecates: <list any existing functionality that will be deprecated by this experiment>
|
||||
|
||||
<Short description of the feature>
|
||||
|
||||
<Short explanation of how users should migrate to the new behavior>
|
||||
|
||||
-->
|
||||
|
||||
### ![deprecated] Version 2 Schema ([#1197][deprecate-version-2-schema])
|
||||
|
||||
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][version-3-release-notes].
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[breaking-change-proposal]: https://github.com/go-task/task/discussions/1191
|
||||
[deprecate-version-2-schema]: https://github.com/go-task/task/issues/1197
|
||||
[version-3-release-notes]: https://github.com/go-task/task/releases/tag/v3.0.0
|
||||
[deprecated]: https://img.shields.io/badge/deprecated-red
|
||||
[experiment]: https://img.shields.io/badge/experiment-yellow
|
||||
<!-- prettier-ignore-end -->
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /faq/
|
||||
sidebar_position: 6
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /integrations/
|
||||
sidebar_position: 5
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Integrations
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /releasing/
|
||||
sidebar_position: 11
|
||||
sidebar_position: 13
|
||||
---
|
||||
|
||||
# Releasing
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /styleguide/
|
||||
sidebar_position: 7
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
# Styleguide
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /taskfile-versions/
|
||||
sidebar_position: 12
|
||||
sidebar_position: 14
|
||||
---
|
||||
|
||||
# Taskfile Versions
|
||||
|
@@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: /translate/
|
||||
sidebar_position: 14
|
||||
sidebar_position: 12
|
||||
---
|
||||
|
||||
# Translate
|
||||
|
Reference in New Issue
Block a user