Skip to content

Commit

Permalink
Document when process directives are evaluated
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Sherman <[email protected]>
  • Loading branch information
bentsherman committed Aug 23, 2023
1 parent b6721b7 commit 76a0b3f
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1166,9 +1166,21 @@ Directives are optional settings that affect the execution of the current proces

They must be entered at the top of the process body, before any other declaration blocks (`input`, `output`, etc), and have the following syntax:

```groovy
// directive with simple value
name value
// directive with list value
name arg1, arg2, arg3
// directive with map value
name key1: val1, key2: val2
// directive with value and options
name arg, opt1: val1, opt2: val2
```
name value [, value2 [,..]]
```

By default, directives are evaluated when the process is defined. However, if the value is a dynamic string or closure, it will be evaluated separately for each task, which allows task-specific variables like `task` and `val` inputs to be used.

Some directives are generally available to all processes, while others depend on the `executor` currently defined.

Expand Down

0 comments on commit 76a0b3f

Please sign in to comment.