Action spec template context

The below keys are available in template strings for the spec field in action configs. Please see here for the fields available for the built-in fields in actions configs, which allow somewhat more limited templating.

Actions can reference outputs defined by providers, via the ${providers.<provider-name>.outputs} key. For details on which outputs are available for a given provider, please refer to the reference docs for the provider in question, and look for the Outputs section.

Action specs can also reference outputs defined by modules and by other actions, via the ${modules.<module-name>.outputs} and ${actions.<action-kind>.<action-name>.outputs} keys.

For details on which outputs are available for a given action type, please refer to the reference docs for the type in question, and look for the Outputs section.

${local.*}

Context variables that are specific to the currently running environment/machine.

Type

object

${local.artifactsPath}

The absolute path to the directory where exported artifacts from test and task runs are stored.

Type

string

Example:

my-variable: ${local.artifactsPath}

${local.env.*}

A map of all local environment variables (see https://nodejs.org/api/process.html#process_process_env).

Type

object

${local.env.<env-var-name>}

The environment variable value.

Type

string

${local.arch}

A string indicating the architecture that the framework is running on (see https://nodejs.org/api/process.html#process_process_arch)

Type

string

Example:

my-variable: ${local.arch}

${local.platform}

A string indicating the platform that the framework is running on (see https://nodejs.org/api/process.html#process_process_platform)

Type

string

Example:

my-variable: ${local.platform}

${local.projectPath}

The absolute path to the project root directory.

Type

string

Example:

my-variable: ${local.projectPath}

${local.username}

The current username (as resolved by https://github.com/sindresorhus/username).

Type

string

Example:

my-variable: ${local.username}

${local.usernameLowerCase}

The current username (as resolved by https://github.com/sindresorhus/username), with any upper case characters converted to lower case.

Type

string

Example:

my-variable: ${local.usernameLowerCase}

${command.*}

Information about the currently running command and its arguments.

Type

object

${command.name}

The currently running Garden CLI command, without positional arguments or option flags. This can be handy to e.g. change some variables based on whether you're running garden test or some other specific command.

Note that this will currently always resolve to "workflow" when running Workflows, as opposed to individual workflow step commands. This may be revisited at a later time, but currently all configuration is resolved once for all workflow steps.

Type

string

Example:

my-variable: ${command.name}

${command.params.*}

A map of all parameters set when calling the current command. This includes both positional arguments and option flags, and includes any default values set by the framework or specific command. This can be powerful if used right, but do take care since different parameters are only available in certain commands, some have array values etc.

Option values can be referenced by the option's default name (e.g. local-mode) or its alias (e.g. local) if one is defined for that option.

Type

object

${command.params.<name>}

Type

any

${datetime.*}

Information about the date/time at template resolution time.

Type

object

${datetime.now}

The current UTC date and time, at time of template resolution, in ISO-8601 format.

Type

string

Example:

my-variable: ${datetime.now}

${datetime.today}

The current UTC date, at time of template resolution, in ISO-8601 format.

Type

string

Example:

my-variable: ${datetime.today}

${datetime.timestamp}

The current UTC Unix timestamp (in seconds), at time of template resolution.

Type

string

Example:

my-variable: ${datetime.timestamp}

${project.*}

Information about the Garden project.

Type

object

${project.name}

The name of the Garden project.

Type

string

Example:

my-variable: ${project.name}

${git.*}

Information about the current state of the project's Git repository.

Type

object

${git.branch}

The current Git branch, if available. Resolves to an empty string if HEAD is in a detached state (e.g. when rebasing), or if the repository has no commits.

When using remote sources, the branch used is that of the project/top-level repository (the one that contains the project configuration).

The branch is resolved at the start of the Garden command's execution, and is not updated if the current branch changes during the command's execution (which could happen, for example, when using watch-mode commands).

Type

string

Example:

my-variable: ${git.branch}

${git.commitHash}

The current Git commit hash, if available. Resolves to an empty string if the repository has no commits.

When using remote sources, the hash used is that of the project/top-level repository (the one that contains the project configuration).

The hash is resolved at the start of the Garden command's execution, and is not updated if the current commit changes during the command's execution (which could happen, for example, when using watch-mode commands).

Type

string

Example:

my-variable: ${git.commitHash}

${git.originUrl}

The remote origin URL of the project Git repository.

When using remote sources, the URL is that of the project/top-level repository (the one that contains the project configuration).

Type

string

Example:

my-variable: ${git.originUrl}

${secrets.<secret-name>}

The secret's value.

Type

string

${variables.*}

A map of all variables defined in the project configuration, including environment-specific variables.

TypeDefault

object

{}

${variables.<variable-name>}

Type

string | number | boolean | link | array[link]

${var.*}

Alias for the variables field.

TypeDefault

object

{}

${var.<name>}

Number, string or boolean

Type

string | number | boolean

${environment.*}

Information about the environment that Garden is running against.

Type

object

${environment.name}

The name of the environment Garden is running against, excluding the namespace.

Type

string

Example:

my-variable: ${environment.name}

${environment.fullName}

The full name of the environment Garden is running against, including the namespace.

Type

string

Example:

my-variable: ${environment.fullName}

${environment.namespace}

The currently active namespace (if any).

Type

string

Example:

my-variable: ${environment.namespace}

${providers.*}

Retrieve information about providers that are defined in the project.

TypeDefault

object

{}

${providers.<provider-name>.config.*}

The resolved configuration for the provider.

Type

object

${providers.<provider-name>.config.<config-key>}

The provider config key value. Refer to individual provider references for details.

Type

string | number | boolean

${providers.<provider-name>.outputs.*}

The outputs defined by the provider (see individual plugin docs for details).

TypeDefault

object

{}

${providers.<provider-name>.outputs.<output-key>}

The provider output value. Refer to individual provider references for details.

Type

string | number | boolean

${modules.*}

Retrieve information about modules that are defined in the project.

TypeDefault

object

{}

${modules.<module-name>.buildPath}

The build path of the module.

Type

string

Example:

my-variable: ${modules.<module-name>.buildPath}

${modules.<module-name>.name}

The name of the module.

Type

string

${modules.<module-name>.path}

The source path of the module.

Type

string

Example:

my-variable: ${modules.<module-name>.path}

${modules.<module-name>.outputs.*}

The outputs defined by the module (see individual module type references for details).

TypeDefault

object

{}

${modules.<module-name>.outputs.<output-name>}

The module output value. Refer to individual module type references for details.

Type

string | number | boolean

${modules.<module-name>.var.*}

A map of all variables defined in the module.

TypeDefault

object

{}

${modules.<module-name>.var.<variable-name>}

Type

string | number | boolean | link | array[link]

${modules.<module-name>.version}

The current version of the module.

Type

string

Example:

my-variable: ${modules.<module-name>.version}

${runtime.*}

Alias for action.

Type

object

${runtime.build.*}

Information about a Build action dependency, including its outputs.

TypeDefault

object

{}

${runtime.build.<action-name>.name}

The name of the action.

Type

string

${runtime.build.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${runtime.build.<action-name>.disabled}

${runtime.build.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${runtime.build.<action-name>.buildPath}

${runtime.build.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${runtime.build.<action-name>.sourcePath}

${runtime.build.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${runtime.build.<action-name>.mode}

${runtime.build.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${runtime.build.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${runtime.build.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${runtime.build.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${runtime.build.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${runtime.build.<action-name>.version}

${runtime.deploy.*}

Information about a Deploy action dependency, including its outputs.

TypeDefault

object

{}

${runtime.deploy.<action-name>.name}

The name of the action.

Type

string

${runtime.deploy.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${runtime.deploy.<action-name>.disabled}

${runtime.deploy.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${runtime.deploy.<action-name>.buildPath}

${runtime.deploy.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${runtime.deploy.<action-name>.sourcePath}

${runtime.deploy.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${runtime.deploy.<action-name>.mode}

${runtime.deploy.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${runtime.deploy.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${runtime.deploy.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${runtime.deploy.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${runtime.deploy.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${runtime.deploy.<action-name>.version}

${runtime.run.*}

Information about a Run action dependency, including its outputs.

TypeDefault

object

{}

${runtime.run.<action-name>.name}

The name of the action.

Type

string

${runtime.run.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${runtime.run.<action-name>.disabled}

${runtime.run.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${runtime.run.<action-name>.buildPath}

${runtime.run.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${runtime.run.<action-name>.sourcePath}

${runtime.run.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${runtime.run.<action-name>.mode}

${runtime.run.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${runtime.run.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${runtime.run.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${runtime.run.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${runtime.run.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${runtime.run.<action-name>.version}

${runtime.test.*}

Information about a Test action dependency, including its outputs.

TypeDefault

object

{}

${runtime.test.<action-name>.name}

The name of the action.

Type

string

${runtime.test.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${runtime.test.<action-name>.disabled}

${runtime.test.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${runtime.test.<action-name>.buildPath}

${runtime.test.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${runtime.test.<action-name>.sourcePath}

${runtime.test.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${runtime.test.<action-name>.mode}

${runtime.test.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${runtime.test.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${runtime.test.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${runtime.test.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${runtime.test.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${runtime.test.<action-name>.version}

${runtime.services.*}

Alias for deploy.

TypeDefault

object

{}

${runtime.services.<action-name>.name}

The name of the action.

Type

string

${runtime.services.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${runtime.services.<action-name>.disabled}

${runtime.services.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${runtime.services.<action-name>.buildPath}

${runtime.services.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${runtime.services.<action-name>.sourcePath}

${runtime.services.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${runtime.services.<action-name>.mode}

${runtime.services.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${runtime.services.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${runtime.services.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${runtime.services.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${runtime.services.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${runtime.services.<action-name>.version}

${runtime.tasks.*}

Alias for run.

TypeDefault

object

{}

${runtime.tasks.<action-name>.name}

The name of the action.

Type

string

${runtime.tasks.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${runtime.tasks.<action-name>.disabled}

${runtime.tasks.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${runtime.tasks.<action-name>.buildPath}

${runtime.tasks.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${runtime.tasks.<action-name>.sourcePath}

${runtime.tasks.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${runtime.tasks.<action-name>.mode}

${runtime.tasks.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${runtime.tasks.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${runtime.tasks.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${runtime.tasks.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${runtime.tasks.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${runtime.tasks.<action-name>.version}

${actions.*}

Runtime outputs and information from other actions (only resolved at runtime when executing actions).

Type

object

${actions.build.*}

Information about a Build action dependency, including its outputs.

TypeDefault

object

{}

${actions.build.<action-name>.name}

The name of the action.

Type

string

${actions.build.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.build.<action-name>.disabled}

${actions.build.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.build.<action-name>.buildPath}

${actions.build.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.build.<action-name>.sourcePath}

${actions.build.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${actions.build.<action-name>.mode}

${actions.build.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.build.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${actions.build.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${actions.build.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${actions.build.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${actions.build.<action-name>.version}

${actions.deploy.*}

Information about a Deploy action dependency, including its outputs.

TypeDefault

object

{}

${actions.deploy.<action-name>.name}

The name of the action.

Type

string

${actions.deploy.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.deploy.<action-name>.disabled}

${actions.deploy.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.deploy.<action-name>.buildPath}

${actions.deploy.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.deploy.<action-name>.sourcePath}

${actions.deploy.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${actions.deploy.<action-name>.mode}

${actions.deploy.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.deploy.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${actions.deploy.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${actions.deploy.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${actions.deploy.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${actions.deploy.<action-name>.version}

${actions.run.*}

Information about a Run action dependency, including its outputs.

TypeDefault

object

{}

${actions.run.<action-name>.name}

The name of the action.

Type

string

${actions.run.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.run.<action-name>.disabled}

${actions.run.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.run.<action-name>.buildPath}

${actions.run.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.run.<action-name>.sourcePath}

${actions.run.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${actions.run.<action-name>.mode}

${actions.run.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.run.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${actions.run.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${actions.run.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${actions.run.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${actions.run.<action-name>.version}

${actions.test.*}

Information about a Test action dependency, including its outputs.

TypeDefault

object

{}

${actions.test.<action-name>.name}

The name of the action.

Type

string

${actions.test.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.test.<action-name>.disabled}

${actions.test.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.test.<action-name>.buildPath}

${actions.test.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.test.<action-name>.sourcePath}

${actions.test.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${actions.test.<action-name>.mode}

${actions.test.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.test.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${actions.test.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${actions.test.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${actions.test.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${actions.test.<action-name>.version}

${actions.services.*}

Alias for deploy.

TypeDefault

object

{}

${actions.services.<action-name>.name}

The name of the action.

Type

string

${actions.services.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.services.<action-name>.disabled}

${actions.services.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.services.<action-name>.buildPath}

${actions.services.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.services.<action-name>.sourcePath}

${actions.services.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${actions.services.<action-name>.mode}

${actions.services.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.services.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${actions.services.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${actions.services.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${actions.services.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${actions.services.<action-name>.version}

${actions.tasks.*}

Alias for run.

TypeDefault

object

{}

${actions.tasks.<action-name>.name}

The name of the action.

Type

string

${actions.tasks.<action-name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.tasks.<action-name>.disabled}

${actions.tasks.<action-name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.tasks.<action-name>.buildPath}

${actions.tasks.<action-name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.tasks.<action-name>.sourcePath}

${actions.tasks.<action-name>.mode}

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

TypeDefault

string

"default"

Example:

my-variable: ${actions.tasks.<action-name>.mode}

${actions.tasks.<action-name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.tasks.<action-name>.var.<name>}

Type

string | number | boolean | link | array[link]

${actions.tasks.<action-name>.outputs.*}

The outputs defined by the action (see individual action/module type references for details).

TypeDefault

object

{}

${actions.tasks.<action-name>.outputs.<output-name>}

The action output value. Refer to individual action/module type references for details.

Type

string | number | boolean

${actions.tasks.<action-name>.version}

The current version of the action.

Type

string

Example:

my-variable: ${actions.tasks.<action-name>.version}

${inputs.*}

The inputs provided to the config through a template, if applicable.

TypeDefault

object

{}

${inputs.<input-key>}

Type

string | number | boolean | link | array[link]

${parent.*}

Information about the config parent, if any (usually a template, if applicable).

Type

object

${parent.name}

The name of the parent config.

Type

string

${template.*}

Information about the template used when generating the config, if applicable.

Type

object