Grammar element · workflow.name + version
A workflow needs an identity before it runs
Three complete identities. Name labels the run; version records the manifest shape.
workflow.yaml4 steps
What the model stores
A required run name, an optional description, and a version defaulting to 1.0.
What workflow.name + version is
Workflow name is the required identity used in logs and results; version records the manifest shape the definition targets.
Neither field establishes dependencies. The graph comes from steps; identity makes that graph recognizable to people and tools.
What it contains
- A required name — A string carried into workflow results.
- A defaulted version —
1.0when the key is omitted. - Optional context — Description documents purpose without changing the run.
Identity labels the graph; it does not build it
Choose a stable name that survives individual run IDs. Keep version as manifest context, then let trigger and steps carry the operational meaning.
Run the complete example
Copy this manifest from the verified documentation project, then run it from the repository root.
workflow:
version: "1.0"
name: docs_workflow
description: Two actions used by the DSL documentation.
trigger: {type: manual}
steps:
- name: prepare
type: action
action: log
params: {message: "Preparation complete."}
retry: {max: 2, delay: 0, backoff: fixed}
- name: publish
type: action
action: log
params: {message: "Publication complete."}
depends_on: [prepare]
when: "1 == 1"
on_failure: fail
hdrctl workflow run examples/tutorial/dsl-elements/workflow.yaml
✓ Step 'prepare' OK (0.0s) ✓ Step 'publish' OK (0.0s) ✅ Workflow 'docs_workflow' completed in 0.0s — 2/2 steps OK
The relevant command syntax, copied from hdrctl workflow run --help:
hdrctl workflow run PATH PATH path to workflow.yaml --lang LANG interface language -h, --help show command help