rayan/go-task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2026-07-09 06:55:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: experiment taskfile envs take precedence over os envs (#1633)

Browse Source 
* feat: experiment taskfile envs take precedence over os envs

* fix test

* fix typo

Co-authored-by: Andrey Nering <andrey@nering.com.br>

* docs: add p about default

---------

Co-authored-by: Andrey Nering <andrey@nering.com.br>
This commit is contained in:
Valentin Maerten
2024-07-17 00:44:34 +02:00
committed by GitHub
parent 5739495739
commit 4b6c79aca5
5 changed files with 103 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
website/docs/experiments/env_precedence.mdx Normal file
View File

@@ -0,0 +1,70 @@
---
draft: false # Hide in production
slug: '/experiments/env-precedence'
---
# Env Precedence (#1038)
:::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.
:::
:::warning
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 ][enabling-experiments] for more
information.
:::
Before this experiment, the OS variable took precedence over the task environment variable. This experiment changes the precedence to make the task environment variable take precedence over the OS variable.
Consider the following example:
```yml
version: '3'
tasks:
default:
env:
KEY: 'other'
cmds:
- echo "$KEY"
```
Running `KEY=some task` before this experiment, the output would be `some`, but after this experiment, the output would be `other`.
If you still want to get the OS variable, you can use the template function env like follow : `{{env "OS_VAR"}}`.
```yml
version: '3'
tasks:
default:
env:
KEY: 'other'
cmds:
- echo "$KEY"
- echo {{env "KEY"}}
```
Running `KEY=some task`, the output would be `other` and `some`.
Like other variables/envs, you can also fall back to a given value using the default template function:
```yml
MY_ENV: '{{.MY_ENV | default "fallback"}}'
```
{/* prettier-ignore-start */}
[enabling-experiments]: ./experiments.mdx#enabling-experiments
{/* prettier-ignore-end */}