exec Run

Description

A simple Run action which runs a command locally with a shell command.

Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our .

exec actions also export values that are available in template strings. See the section below for details.

Configuration Keys

type

The type of action, e.g. exec, container or kubernetes. Some are built into Garden but mostly these will be defined by your configured providers.

name

A valid name for the action. Must be unique across all actions of the same kind in your project.

description

A description of the action.

source

By default, the directory where the action is defined is used as the source for the build context.

You can override this by setting either source.path to another (POSIX-style) path relative to the action source directory, or source.repository to get the source from an external repository.

If using source.path, you must make sure the target path is in a git repository.

source.path

A relative POSIX-style path to the source directory for this action. You must make sure this path exists and is in a git repository!

source.repository

When set, Garden will import the action source from this repository, but use this action configuration (and not scan for configs in the separate repository).

source.repository.url

A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #<branch|tag>

Example:

dependencies[]

A list of other actions that this action depends on, and should be built, deployed or run (depending on the action type) before processing this action.

Each dependency should generally be expressed as a "<kind>.<name>" string, where is one of build, deploy, run or test, and is the name of the action to depend on.

You may also optionally specify a dependency as an object, e.g. { kind: "Build", name: "some-image" }.

Any empty values (i.e. null or empty strings) are ignored, so that you can conditionally add in a dependency via template expressions.

Example:

disabled

Set this to true to disable the action. You can use this with conditional template strings to disable actions based on, for example, the current environment or other variables (e.g. disabled: ${environment.name == "prod"}). This can be handy when you only need certain actions for specific environments, e.g. only for development.

For Build actions, this means the build is not performed unless it is declared as a dependency by another enabled action (in which case the Build is assumed to be necessary for the dependant action to be run or built).

For other action kinds, the action is skipped in all scenarios, and dependency declarations to it are ignored. Note however that template strings referencing outputs (i.e. runtime outputs) will fail to resolve when the action is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.

environments[]

If set, the action is only enabled for the listed environment types. This is effectively a cleaner shorthand for the disabled field with an expression for environments. For example, environments: ["prod"] is equivalent to disabled: ${environment.name != "prod"}.

include[]

Specify a list of POSIX-style paths or globs that should be regarded as source files for this action, and thus will affect the computed version of the action.

For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. An exception would be e.g. an exec action without a build reference, where the relevant files cannot be inferred and you want to define which files should affect the version of the action, e.g. to make sure a Test action is run when certain files are modified.

Build actions have a different behavior, since they generally are based on some files in the source tree, so please reference the docs for more information on those.

Example:

exclude[]

Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the action's version.

Unlike the scan.exclude field in the project config, the filters here have no effect on which files and directories are watched for changes when watching is enabled. Use the project scan.exclude field to affect those, if you have large directories that should not be watched for changes.

Example:

variables

A map of variables scoped to this particular action. These are resolved before any other parts of the action configuration and take precedence over group-scoped variables (if applicable) and project-scoped variables, in that order. They may reference group-scoped and project-scoped variables, and generally can use any template strings normally allowed when resolving the action.

varfiles[]

Specify a list of paths (relative to the directory where the action is defined) to a file containing variables, that we apply on top of the action-level variables field, and take precedence over group-level variables (if applicable) and project-level variables, in that order.

If you specify multiple paths, they are merged in the order specified, i.e. the last one takes precedence over the previous ones.

The format of the files is determined by the configured file's extension:

• .yaml/.yml - YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may contain any value type. YAML format is used by default.

• .json - JSON. Must contain a single JSON object (not an array).

NOTE: The default varfile format was changed to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.

To use different varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-action.${environment.name}.env" (this assumes that the corresponding varfiles exist).

If a listed varfile cannot be found, throwing an error. To add optional varfiles, you can use a list item object with a path and an optional optional boolean field.

Example:

varfiles[].path

Path to a file containing a path.

varfiles[].optional

Whether the varfile is optional.

build

Specify a Build action, and resolve this action from the context of that Build.

For example, you might create an exec Build which prepares some manifests, and then reference that in a kubernetes Deploy action, and the resulting manifests from the Build.

This would mean that instead of looking for manifest files relative to this action's location in your project structure, the output directory for the referenced exec Build would be the source.

kind

timeout

Set a timeout for the run to complete, in seconds.

spec

spec.shell

If true, runs file inside of a shell. Uses /bin/sh on UNIX and cmd.exe on Windows. A different shell can be specified as a string. The shell should understand the -c switch on UNIX or /d /s /c on Windows.

Note that if this is not set, no shell interpreter (Bash, cmd.exe, etc.) is used, so shell features such as variables substitution (echo $PATH) are not allowed.

We recommend against using this option since it is:

• not cross-platform, encouraging shell-specific syntax.

• slower, because of the additional shell interpretation.

• unsafe, potentially allowing command injection.

spec.artifacts[]

A list of artifacts to copy after the run.

spec.artifacts[].source

A POSIX-style path or glob to copy, relative to the build root.

spec.artifacts[].target

A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts.

spec.command[]

The command to run.

Note that if a Build is referenced in the build field, the command will be run from the build directory for that Build action. If that Build has buildAtSource: true set, the command will be run from the source directory of the Build action. If no build reference is set, the command is run from the source directory of this action.

Example: ["npm","run","build"]

spec.env

Environment variables to set when running the command.

Outputs

The following keys are available via the ${actions.run.<name>} template string key for exec action.

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

The name of the action.

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

Whether the action is disabled.

Example:

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

The local path to the action build directory.

Example:

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

The local path to the action source directory.

Example:

${actions.run.<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.

Example:

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

The variables configured on the action.

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

${actions.run.<name>.outputs.log}

The full log output from the executed command. (Pro-tip: Make it machine readable so it can be parsed by dependants)

${actions.run.<name>.outputs.stdout}

The stdout log output from the executed command. (Pro-tip: Make it machine readable so it can be parsed by dependants)

${actions.run.<name>.outputs.stderr}

The stderr log output from the executed command. (Pro-tip: Make it machine readable so it can be parsed by dependants)