Skip to content

[Workflows] Parallel step reference - #7691

Open
natasha-moore-elastic wants to merge 1 commit into
mainfrom
issue-7248
Open

[Workflows] Parallel step reference#7691
natasha-moore-elastic wants to merge 1 commit into
mainfrom
issue-7248

Conversation

@natasha-moore-elastic

@natasha-moore-elastic natasha-moore-elastic commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Adds a reference page for the parallel step, which runs branches concurrently, and links to it from the flow control overview, the step type index, the cheat sheet, "Choose the right step", and the steps hub.

Resolves #7248

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@natasha-moore-elastic
natasha-moore-elastic requested a review from a team as a code owner July 31, 2026 15:53
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 3 suggestions found

💡 Suggestions (3): Optional style improvements. Apply when helpful.
File Line Rule Message
explore-analyze/workflows/steps/flow-control-steps.md 139 Elastic.Wordiness Consider using 'all' instead of 'all of '.
explore-analyze/workflows/steps/parallel.md 43 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
explore-analyze/workflows/steps/parallel.md 44 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@shahargl shahargl left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Natasha — this is a strong, accurate parallel-step reference. I checked the technical claims against the engine/schema and they largely match.

Two small fixes requested below before merge. Everything else looks good (defaults, foreach context, branch limits, fail-fast vs settled, output shape, applies_to consistency).

serverless: preview
```

Run branches at the same time and continue when all of them reach a terminal state. Choose one of two modes: dynamic fan-out (`foreach` plus `steps`) runs the same body once per item in a runtime list, and static branches (`branches`) run a fixed set of named branches that each do different work. A step can't use both.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit / Vale: "all of them" → prefer "every branch" (matches the wording already used in parallel.md).

Suggested:

Run branches at the same time and continue when every branch reaches a terminal state.

| Field | Description |
|---|---|
| `results[].index` | Zero-based branch position. Always present. |
| `results[].key` | For static branches, the branch `name`. For dynamic fan-out, the item captured when the step started. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarify dynamic results[].key: in the engine this is the full captured item value (key: item), which can be an object (e.g. a whole ES hit), not just a short string/id.

Suggested:

| `results[].key` | For static branches, the branch `name`. For dynamic fan-out, the full item value captured when the step started (may be an object, not just a string). |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Security][Workflows][9.5 & Serverless] Document the parallel step's new static branches mode (and its undocumented dynamic mode)

3 participants