Skip to content

Job Variables ​

Use job variables to override a shared value for a saved job or request an input when someone starts it. Tasks read these values through vars.*.

See Variables for the inheritance rules.

Configure infrastructure folder values ​

Set overrides on an infrastructure job folder when its jobs need common defaults. Nested folders can override parent values. Endpoint-job folders organize jobs but do not supply inherited variable values.

Configure a job ​

On a saved job's Variables tab, choose a custom variable and configure:

  • Override inherited value when every run should use a job-specific value.
  • Prompt when the person launching the job may supply a run-specific value.

For a non-secret string, offer fixed choices when only certain values make sense. Allow custom values when other text is acceptable. Secret inputs remain masked and are not prefilled.

An endpoint job's displayed default does not include values specific to an endpoint, group, product, or package. Those values are resolved for the actual target and task.

Start a job ​

Input choiceMeaning
DefaultUse the configured effective value.
Custom valueSupply a value for this run.
No valueExplicitly supply null for a non-secret variable.
Empty textSupply an empty string where the prompt allows it.

A job override or run input applies to every target and task. Without one, inherited values can differ across targets. Missing values resolve to null; design the job to handle them.

Schedules, webhooks, and other automated starts do not ask for prompt values. Child jobs resolve their own configuration and do not receive the parent's launch values.

Run snapshots ​

Infrastructure runs keep the variable values captured when they start. Endpoint runs keep the job and launch values, while target-specific values remain resolved in their endpoint context. Changing a default does not replace a captured run input.

Copy, templates, and bundles ​

Copies, templates, and complete bundles preserve prompt definitions. Persistent overrides and run values are excluded; configure the copied or imported job's environment-specific values before running it.

Use values in tasks ​

Reference a value in a template:

text
{{ vars.release.channel }}

Check availability in a condition:

text
vars.release.channel != null

Use is_empty(vars.release.channel) only when null and empty text should be treated alike. Zero and false can be valid values.

Runtime values and passwords ​

Set job variable and Generate password create job.vars.* values for later tasks on the same target. They are separate from persistent vars.* values.

Secret values are masked in run views, but the tasks that use them receive the value. Treat retained run data and collected output accordingly. See runtime variables for scope and retention.