Skip to content

Commit fef2531

Browse files
claireguyotteo
authored andcommitted
[doc][core] A quick documentation is added for declaring tasks as non-critical tasks.
1 parent 4b64cc2 commit fef2531

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/handbook/configuration.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# Workflow and Task Configuration
1+
# Workflow and Task Configuration
2+
3+
## Non-critical tasks
4+
5+
Any task in a workflow can be declared as non-critical. A non-critical task is a task that doesn't trigger a global environment ERROR in case of failure. The state of a non-critical task doesn't affect the environment state in any way.
6+
7+
To declare a task as non-critical, a line has to be added in the corresponding workflow template. Under the task role, in the `task` section (usually after the `load` statement), the line to add is `critical: false`, like in the following example:
8+
9+
```yaml
10+
roles:
11+
- name: "non-critical-task"
12+
vars:
13+
non-critical-task-var: 'var-value'
14+
task:
15+
load: mytask
16+
critical: false
17+
```

0 commit comments

Comments
 (0)