Skip to content

Commit 76eea07

Browse files
committed
Workflow Doc: Clarified behavior of workflow user field params passing to sub-jobs.
1 parent 2e429ba commit 76eea07

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/workflows.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,15 +180,16 @@ Example: Event A → Repeat (x10) → Event A has a `continue` wire → Event B.
180180

181181
Inputs and outputs are automatically passed along:
182182

183-
- At workflow start, the engine blends the workflow job's `params` with any inbound `input.data` and passes `input.files` to the trigger node. The trigger nodes passes these on to any soldered nodes.
183+
- At workflow start, the inbound `input.data` and `input.files` are passed to the trigger node. The trigger nodes passes these on to any soldered nodes.
184184
- When an Event/Job finishes, its output `data` and `files` are passed to downstream nodes as `input.data` and `input.files`.
185+
- If the workflow itself has any user fields defined, these are passed to all sub-jobs via a `workflow.params` object inside the job data.
185186
- Tags: user tags from sub-jobs bubble up to the workflow job and can drive `tag:...` conditions.
186187
- HTML and table content: if a sub-job emits `html` or `table`, it bubbles up to the parent for display. If multiple jobs emit content The latter prevails.
187188
- Retries: if a sub-job was retried, its data/files are not bubbled and it doesn't count toward tag/condition firing.
188189

189190
Join specifics:
190191

191-
- The next node after a Join receives `input.data` with two properties: `items` (array of each upstream job's data) and `combined` (shallow merge of all data).
192+
- The next node after a Join Controller receives a custom `input.data` with two properties: `items` (array of each upstream job's data) and `combined` (shallow merge of all data).
192193
- Any files are concatenated onto the `input.files` array.
193194

194195
Split specifics:

0 commit comments

Comments
 (0)