Skip to content

Commit f2a58fa

Browse files
authored
Merge branch 'main' into fix-1056-user-defined-container-name
2 parents 00cc01b + 509d855 commit f2a58fa

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

dsl-reference.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ Allows workflows to execute multiple subtasks concurrently, enabling parallel pr
609609
| Name | Type | Required | Description|
610610
|:--|:---:|:---:|:---|
611611
| fork.branches | [`map[string, task][]`](#task) | `no` | The tasks to perform concurrently. |
612-
| fork.compete | `boolean` | `no` | Indicates whether or not the concurrent [`tasks`](#task) are racing against each other, with a single possible winner, which sets the composite task's output. Defaults to `false`. |
612+
| fork.compete | `boolean` | `no` | Indicates whether or not the concurrent [`tasks`](#task) are racing against each other, with a single possible winner, which sets the composite task's output.<br>*If set to `false`, the task returns an array that includes the outputs from each branch, preserving the order in which the branches are declared.*<br>*If to `true`, the task returns only the output of the winning branch.*<br>*Defaults to `false`.* |
613613

614614
##### Examples
615615

@@ -818,6 +818,11 @@ do:
818818
image: fake-image
819819
```
820820

821+
> [!NOTE]
822+
> When a `container process` is executed, runtime implementations are recommended to follow a predictable naming convention for the container name. This can improve monitoring, logging, and container lifecycle management.
823+
>
824+
> The Serverless Workflow specification recommends using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}`
825+
821826
##### Script Process
822827

823828
Enables the execution of custom scripts or code within a workflow, empowering workflows to perform specialized logic, data processing, or integration tasks by executing user-defined scripts written in various programming languages.
@@ -826,12 +831,21 @@ Enables the execution of custom scripts or code within a workflow, empowering wo
826831

827832
| Name | Type | Required | Description |
828833
|:--|:---:|:---:|:---|
829-
| language | `string` | `yes` | The language of the script to run |
834+
| language | `string` | `yes` | The language of the script to run.<br>*Supported values are: [`js`](https://tc39.es/ecma262/2024/) and [`python`](https://www.python.org/downloads/release/python-3131/).* |
830835
| code | `string` | `no` | The script's code.<br>*Required if `source` has not been set.* |
831836
| source | [externalResource](#external-resource) | `no` | The script's resource.<br>*Required if `code` has not been set.* |
832837
| arguments | `map` | `no` | A list of the arguments, if any, of the script to run |
833838
| environment | `map` | `no` | A key/value mapping of the environment variables, if any, to use when running the configured script process |
834839

840+
> [!WARNING]
841+
> To ensure cross-compatibility, Serverless Workflow strictly limits the versions of supported scripting languages. These versions may evolve with future releases. If you wish to use a different version of a language, you may do so by utilizing the [`container process`](#container-process).
842+
843+
**Supported languages**
844+
| Language | Version |
845+
|:-----------|:---------:|
846+
| `JavaScript` | [`ES2024`](https://tc39.es/ecma262/2024/) |
847+
| `Python` | [`3.13.x`](https://www.python.org/downloads/release/python-3131/) |
848+
835849
###### Examples
836850

837851
```yaml
@@ -1111,6 +1125,9 @@ Flow Directives are commands within a workflow that dictate its progression.
11111125
| `"end"` | Provides a graceful conclusion to the workflow execution, signaling its completion explicitly. |
11121126
| `string` | Continues the workflow at the task with the specified name |
11131127

1128+
> [!WARNING]
1129+
> Flow directives may only redirect to tasks declared within their own scope. In other words, they cannot target tasks at a different depth.
1130+
11141131
### External Resource
11151132

11161133
Defines an external resource.

dsl.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ Once the task has been executed, different things can happen:
183183
- `fault`: the task raised an uncaught error, which abruptly halts the workflow's execution and makes it transition to `faulted` [status phase](#status-phases).
184184
- `end`: the task explicitly and gracefully ends the workflow's execution.
185185

186+
> [!WARNING]
187+
> Flow directives may only redirect to tasks declared within their own scope. In other words, they cannot target tasks at a different depth.
188+
186189
### Data Flow
187190

188191
In Serverless Workflow DSL, data flow management is crucial to ensure that the right data is passed between tasks and to the workflow itself.
@@ -348,7 +351,8 @@ When the evaluation of an expression fails, runtimes **must** raise an error wit
348351
| workflow | [`workflowDescriptor`](#workflow-descriptor) | Describes the current workflow. |
349352
| runtime | [`runtimeDescriptor`](#runtime-descriptor) | Describes the runtime. |
350353

351-
⚠️ **Warning**: Use `$secrets` with caution: incorporating them in expressions or passing them as call inputs may inadvertently expose sensitive information.
354+
> [!WARNING]
355+
> Use `$secrets` with caution: incorporating them in expressions or passing them as call inputs may inadvertently expose sensitive information.
352356
353357
##### Runtime Descriptor
354358

@@ -407,7 +411,8 @@ The following table shows which arguments are available for each runtime express
407411
| Task `export.as` | Transformed task output | `$context` |||||||||
408412
| Workflow `output.as` | Last task's transformed output | Transformed workflow output || | || ||| |
409413

410-
⚠️ **Warning**: Use `$secrets` with caution: incorporating them in expressions or passing them as call inputs may inadvertently expose sensitive information.
414+
> [!WARNING]
415+
> Use `$secrets` with caution: incorporating them in expressions or passing them as call inputs may inadvertently expose sensitive information.
411416
412417
### Fault Tolerance
413418

0 commit comments

Comments
 (0)