go/task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2025-08-08 22:36:57 +02:00
Code Issues Releases Activity

docs: use .taskrc instead of .task-experiments.yml in our docs (#2157)

Browse Source 
* docs: use .taskrc instead of .task-experiments.yml in our docs

* fix formatting

* fix: whitespace in experiments.mdx

---------

Co-authored-by: Pete Davison <pd93.uk@outlook.com>
This commit is contained in:
Valentin Maerten
2025-04-03 13:29:00 +02:00
committed by GitHub
parent ce032dc46b
commit a6a9792b7e
2 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
website/docs/experiments/experiments.mdx
View File

@ -50,33 +50,33 @@ Which method you use depends on how you intend to use the experiment:
export TASK_X_FEATURE=1 export TASK_X_FEATURE=1
``` ```
3. Creating a `.env` or a `.task-experiments.yml` file in the same directory as 3. Creating a `.env` or a `.taskrc.yml` file in the same directory as
your root Taskfile.\ your root Taskfile.\
The `.env` file should contain the relevant environment The `.env` file should contain the relevant environment
variable(s), while the `.task-experiments.yml` file should use a YAML format variable(s), while the `.taskrc.yml` file should use a YAML format
where each experiment is defined as a key with a corresponding value. where each experiment is defined as a key with a corresponding value.
This allows you to enable an experimental feature at a project level. If you This allows you to enable an experimental feature at a project level. If you
commit this file to source control, then other users of your project will commit this file to source control, then other users of your project will
also have these experiments enabled. also have these experiments enabled.
If both files are present, the values in the `.task-experiments.yml` file If both files are present, the values in the `.taskrc.yml` file
will take precedence. will take precedence.
<Tabs values={[ {label: '.task-experiments.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}> <Tabs values={[ {label: '.taskrc.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}>
<TabItem value="yaml"> <TabItem value="yaml">
```yaml title=".taskrc.yml" ```yaml title=".taskrc.yml"
experiments: experiments:
FEATURE: 1 FEATURE: 1
``` ```
</TabItem> </TabItem>
<TabItem value="env"> <TabItem value="env">
```shell title=".env" ```shell title=".env"
TASK_X_FEATURE=1 TASK_X_FEATURE=1
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
## Workflow ## Workflow

32
website/versioned_docs/version-latest/experiments/experiments.mdx
View File

@ -50,33 +50,33 @@ Which method you use depends on how you intend to use the experiment:
export TASK_X_FEATURE=1 export TASK_X_FEATURE=1
``` ```
3. Creating a `.env` or a `.task-experiments.yml` file in the same directory as 3. Creating a `.env` or a `.taskrc.yml` file in the same directory as
your root Taskfile.\ your root Taskfile.\
The `.env` file should contain the relevant environment The `.env` file should contain the relevant environment
variable(s), while the `.task-experiments.yml` file should use a YAML format variable(s), while the `.taskrc.yml` file should use a YAML format
where each experiment is defined as a key with a corresponding value. where each experiment is defined as a key with a corresponding value.
This allows you to enable an experimental feature at a project level. If you This allows you to enable an experimental feature at a project level. If you
commit this file to source control, then other users of your project will commit this file to source control, then other users of your project will
also have these experiments enabled. also have these experiments enabled.
If both files are present, the values in the `.task-experiments.yml` file If both files are present, the values in the `.taskrc.yml` file
will take precedence. will take precedence.
<Tabs values={[ {label: '.task-experiments.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}> <Tabs values={[ {label: '.taskrc.yml', value: 'yaml'}, {label: '.env', value: 'env'}]}>
<TabItem value="yaml"> <TabItem value="yaml">
```yaml title=".taskrc.yml" ```yaml title=".taskrc.yml"
experiments: experiments:
FEATURE: 1 FEATURE: 1
``` ```
</TabItem> </TabItem>
<TabItem value="env"> <TabItem value="env">
```shell title=".env" ```shell title=".env"
TASK_X_FEATURE=1 TASK_X_FEATURE=1
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
## Workflow ## Workflow