mirror of
https://github.com/go-task/task.git
synced 2025-08-08 22:36:57 +02:00
fix custom container formatting
This commit is contained in:
@@ -10,8 +10,10 @@ Contributions to Task are very welcome, but we ask that you read this document
|
||||
before submitting a PR.
|
||||
|
||||
::: info
|
||||
|
||||
This document applies to the core [Task][task] repository _and_ [Task for Visual
|
||||
Studio Code][vscode-task].
|
||||
|
||||
:::
|
||||
|
||||
## Before you start
|
||||
|
@@ -7,10 +7,12 @@ outline: deep
|
||||
# Completion Scripts
|
||||
|
||||
::: danger
|
||||
|
||||
This deprecation breaks the following functionality:
|
||||
|
||||
- Any direct references to the completion scripts in the Task git repository
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
Direct use of the completion scripts in the `completion/*` directory of the
|
||||
[github.com/go-task/task][task] Git repository is deprecated. Any shell
|
||||
|
@@ -9,10 +9,12 @@ outline: deep
|
||||
# Template Functions
|
||||
|
||||
::: danger
|
||||
|
||||
This deprecation breaks the following functionality:
|
||||
|
||||
- A small set of templating functions
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
The following templating functions are deprecated. Any replacement functions are
|
||||
listed besides the function being removed.
|
||||
|
@@ -10,11 +10,13 @@ outline: deep
|
||||
# {Name of Deprecated Feature} (#{Issue})
|
||||
|
||||
::: danger
|
||||
|
||||
This deprecation breaks the following functionality:
|
||||
|
||||
- {list any existing functionality that will be broken by this deprecation}
|
||||
- {if there are no breaking changes, remove this admonition}
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
{Short description of the feature/behavior and why it is being deprecated}
|
||||
|
||||
|
@@ -7,11 +7,13 @@ outline: deep
|
||||
# Version 2 Schema (#1197)
|
||||
|
||||
::: danger
|
||||
|
||||
This deprecation breaks the following functionality:
|
||||
|
||||
- Any Taskfiles that use the version 2 schema
|
||||
- `Taskvar.yml` files
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
The Taskfile version 2 schema was introduced in March 2018 and replaced by
|
||||
version 3 in August 2019. In May 2023 [we published a deprecation
|
||||
|
@@ -8,21 +8,26 @@ outline: deep
|
||||
# Env Precedence (#1038)
|
||||
|
||||
::: warning
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: danger
|
||||
|
||||
This experiment breaks the following functionality:
|
||||
|
||||
- environment variable will take precedence over OS environment variables
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
::: info
|
||||
|
||||
To enable this experiment, set the environment variable:
|
||||
`TASK_X_ENV_PRECEDENCE=1`. Check out [our guide to enabling
|
||||
experiments](/experiments/#enabling-experiments) for more information.
|
||||
|
||||
:::
|
||||
|
||||
Before this experiment, the OS variable took precedence over the task
|
||||
|
@@ -7,20 +7,26 @@ outline: deep
|
||||
# Gentle Force (#1200)
|
||||
|
||||
::: warning
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: danger
|
||||
|
||||
This experiment breaks the following functionality:
|
||||
|
||||
- The `--force` flag
|
||||
:::
|
||||
|
||||
:::
|
||||
|
||||
::: info
|
||||
|
||||
To enable this experiment, set the environment variable:
|
||||
`TASK_X_GENTLE_FORCE=1`. Check out [our guide to enabling experiments](/experiments/#enabling-experiments) for more information.
|
||||
|
||||
:::
|
||||
|
||||
The `--force` flag currently forces _all_ tasks to run regardless of the status
|
||||
|
@@ -7,9 +7,11 @@ outline: deep
|
||||
# Experiments
|
||||
|
||||
::: warning
|
||||
|
||||
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 sometimes roll out breaking changes
|
||||
@@ -108,9 +110,11 @@ implementation is now available for use in a release and the experiment is open
|
||||
for feedback.
|
||||
|
||||
::: info
|
||||
|
||||
During the draft period, major changes to the implementation may be made based
|
||||
on the feedback received from users. There are _no stability guarantees_ and
|
||||
experimental features may be abandoned _at any time_.
|
||||
|
||||
:::
|
||||
|
||||
### 3. Candidate
|
||||
|
@@ -7,18 +7,24 @@ outline: deep
|
||||
# Remote Taskfiles (#1317)
|
||||
|
||||
::: warning
|
||||
|
||||
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.
|
||||
|
||||
:::
|
||||
|
||||
::: info
|
||||
|
||||
To enable this experiment, set the environment variable:
|
||||
`TASK_X_REMOTE_TASKFILES=1`. Check out [our guide to enabling experiments](/experiments/#enabling-experiments) for more information.
|
||||
|
||||
:::
|
||||
|
||||
::: danger
|
||||
|
||||
Never run remote Taskfiles from sources that you do not trust.
|
||||
|
||||
:::
|
||||
|
||||
This experiment allows you to use Taskfiles which are stored in remote
|
||||
|
@@ -9,8 +9,10 @@ outline: deep
|
||||
Task offers many installation methods. Check out the available methods below.
|
||||
|
||||
::: info
|
||||
|
||||
Some of the methods below are marked as . This means they
|
||||
are not maintained by the Task team and may not be up-to-date.
|
||||
|
||||
:::
|
||||
|
||||
## Package Managers
|
||||
@@ -178,8 +180,10 @@ sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
|
||||
```
|
||||
|
||||
::: warning
|
||||
|
||||
On macOS and Windows, `~/.local/bin` and `~/bin` are not added to `$PATH` by
|
||||
default.
|
||||
|
||||
:::
|
||||
|
||||
By default, it installs the latest version available.
|
||||
@@ -231,9 +235,11 @@ env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest
|
||||
```
|
||||
|
||||
::: tip
|
||||
|
||||
For CI environments we recommend using the [install script](#install-script)
|
||||
instead, which is faster and more stable, since it'll just download the latest
|
||||
released binary.
|
||||
|
||||
:::
|
||||
|
||||
## Setup completions
|
||||
|
@@ -14,7 +14,9 @@ task [options] [tasks...] [-- CLI_ARGS...]
|
||||
```
|
||||
|
||||
::: tip
|
||||
|
||||
If `--` is given, all remaining arguments will be assigned to a special `CLI_ARGS` variable
|
||||
|
||||
:::
|
||||
|
||||
## Commands
|
||||
@@ -297,11 +299,15 @@ Task uses specific exit codes to indicate different types of errors:
|
||||
- **207** - Variable has incorrect value
|
||||
|
||||
::: info
|
||||
|
||||
When using `-x/--exit-code`, failed command exit codes are passed through instead of the above codes.
|
||||
|
||||
:::
|
||||
|
||||
::: tip
|
||||
|
||||
The complete list of exit codes is available in the repository at [`errors/errors.go`](https://github.com/go-task/task/blob/main/errors/errors.go).
|
||||
|
||||
:::
|
||||
|
||||
## JSON Output Format
|
||||
|
@@ -40,8 +40,9 @@ the this package's functionality is exposed via the [`task.Executor`] which
|
||||
allows the user to fetch and execute tasks from a Taskfile.
|
||||
|
||||
::: info
|
||||
This is the package which is most likely to be the subject of breaking changes
|
||||
as we refine the API.
|
||||
|
||||
This is the package which is most likely to be the subject of breaking changes as we refine the API.
|
||||
|
||||
:::
|
||||
|
||||
### [`github.com/go-task/task/v3/taskfile`]
|
||||
@@ -137,8 +138,9 @@ This compiles the DAG into a single [`ast.Taskfile`] containing all the
|
||||
namespaces and tasks from all the Taskfiles we read.
|
||||
|
||||
::: info
|
||||
We plan to remove AST merging in the future as it is unnecessarily complex and
|
||||
causes lots of issues with scoping.
|
||||
|
||||
We plan to remove AST merging in the future as it is unnecessarily complex and causes lots of issues with scoping.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user