Input and Output Variables

Variables can be used to defined inputs and outputs for the build and deployment stages. They can also be used to make Errands configurable.

Variables are strongly typed, which is checked at both build and deploy time. A task can’t succeed if the required variables have not been configured correctly.

Escape Plan

Variables can be configured in the Escape Plan under the inputs, build_inputs, deploy_inputs and outputs fields.

FieldTypeDescription
idstringA unique name for this variable. Required field.
typestringThe variable type. Before executing any steps Escape will make sure that all the values match the types that are set on the variables.
One of: string, list, integer, bool.
Default: string
defaultanyA default value for this variable. This value will be used if no value has been specified by the user.
descriptionstringA description of the variable.
friendlystringA friendly name for this variable for presentational purposes only.
visibleboolControl whether or not this variable should be visible when deploying interactively. In other words: should the user be asked to input this value? It only really makes sense to set this to true if there a default is set.
options{string:any}Options that put more constraints on the type.
sensitiveboolIs this sensitive data?
itemsanyIf set, this should contain all the valid values for this variable.
eval_before_dependenciesboolShould the variables be evaluated before the dependencies are deployed?
scopesscopes.ScopesA list of scopes (build, deploy) that defines during which stage(s) this variable should be active. You wouldn’t usually use this field directly, but use something like build_inputs or deploy_inputs, which usually express intent better.