From 890c9ea8752339d60775ae25575f085e1ca5af1a Mon Sep 17 00:00:00 2001 From: Valentin Maerten Date: Wed, 7 May 2025 11:59:13 +0200 Subject: [PATCH] add docs --- website/docs/reference/schema-taskrc.mdx | 31 ++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 website/docs/reference/schema-taskrc.mdx diff --git a/website/docs/reference/schema-taskrc.mdx b/website/docs/reference/schema-taskrc.mdx new file mode 100644 index 00000000..fc7a69a5 --- /dev/null +++ b/website/docs/reference/schema-taskrc.mdx @@ -0,0 +1,31 @@ +--- +slug: /reference/schema-taskrc +sidebar_position: 4 +toc_min_heading_level: 2 +toc_max_heading_level: 5 +--- + +# Schema taskrc Reference + +The `.taskrc` file is the configuration file used by Task. It can have either a `.yml` or `.yaml` extension and can be located in two places: + +- **Local** – at the root of the project. +- **Global** – in the user's HOME directory. + +When both local and global `.taskrc.yml` files are present, their contents are merged. If the same key exists in both files, the value from the local file takes precedence over the global one. + +## Schema + +| Attribute | Type | Default | Description | +|---------------|-------------------------------------|---------|------------------------------------------------------| +| `version` | `string` | | Version of the Taskfile. The current version is `3`. | +| `experiments` | [`map[string]number`](#experiments) | | Experiments to enable or disable | + +## Experiments + +| Attribute | Type | Default | Description | +|--------------------|----------|---------|----------------------------------------------------------| +| `REMOTE_TASKFILES` | `number` | | Enable (1) or disable (0) the remote taskfile experiment | +| `ENV_PRECEDENCE` | `number` | | Enable (1) or disable (0) the env precedence experiment. | +| `GENTLE_FORCE` | `number` | | Enable (1) or disable (0) the gentle force experiment. | +