Skip to content

Steps

A step is one unit of work inside a job. See Steps for the guide.

YAML path: steps[]

Step is one unit of work: exactly one of Run, Uses or Template is set.

  • Exactly one of: run, uses, template.
  • Unknown keys are rejected.
Key Type Required Description
id string Identifier used in steps.<id>.outputs.<key>.
name string
uses string Plugin step (owner/name@ref), docker://image, ./local/path or github://owner/repo@ref.
run string Shell script. Secrets must be passed through env, not interpolated.
template string Org-level step template (org/name@version).
with map
shell bash | sh | pwsh | python | node
working_directory string
env map of string | number | boolean
timeout string Examples: 30s, 15m, 1h30m, 2d. A duration such as 30s, 15m, 1h30m or 2d, or an expression.
continue_on_error boolean or string Treat a failure of this step as non-fatal.
if string Condition for running the step. Default success().