Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesTerraformTunnelsYAMLBuddy GitCLIAPIFAQ

YAML for Set variables

View as Markdown

Set variables (SET_VARIABLES)

YAML parameters for Set variables

PARAMETERS
typerequiredstring

Value: SET_VARIABLES

actionrequiredstring
Unique identifier for the action within the pipeline.
permissionsPermissionsYaml
Access permissions for the action.
commentstring
Comment to add when approving/rejecting.
descriptionstring
Description or message shown to approvers.
prevent_self_approvalboolean
If set to true, the approver must be different from the person who triggered the run. Default: false.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
When true, the action runs only on the first failure instead of on each failure. Used only when trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds. It cannot exceed the action time limit of the workspace plan; a higher value is rejected.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.

Constraints: ≤ 10

run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Nov 2, 2026

Previous pageSentry Self-HostedNext pageShopify

YAML examples for Set variables

Set variables with different options

yaml
- action: "Set Variables"
  type: "SET_VARIABLES"
  comment: "comment"
  variables:
    - key: "var1"
      type: "VAR"
    - key: "var2"
      type: "VAR"
      defaults: "option1\noption2"
    - key: "var3"
      type: "VAR"
      init_path: "/fileWithOptions"
    - key: "var4"
      type: "VAR"

Set variables with permissions

yaml
- action: "Set Variables"
  type: "SET_VARIABLES"
  comment: "comment"
  variables:
    - key: "var1"
      type: "VAR"
  permissions:
    others: "DENIED"
    users:
      alex: "DENIED"
      mike: "ALLOWED"
    groups:
      frontend: "DENIED"
      backend: "ALLOWED"