exec Build
A simple Build action which runs a build locally with a shell command.
Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our Configuration guide.
The first section contains the complete YAML schema, and the second section describes each schema key.
exec actions also export values that are available in template strings. See the Outputs section below for details.The values in the schema below are the default values.
# 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.
type:
# A valid name for the action. Must be unique across all actions of the same _kind_ in your project.
name:
# A description of the action.
description:
# 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.
#
# For `source.repository` behavior, please refer to the [Remote Sources
# guide](https://docs.garden.io/advanced/using-remote-sources).
source:
# 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!
path:
# 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).
repository:
# A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific
# branch or tag, with the format: <git remote url>#<branch|tag>
url:
# 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 _<kind>_ is one of `build`,
# `deploy`, `run` or `test`, and _<name>_ 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.
dependencies: []
# 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.
disabled: false
# 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.
variables:
# 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:
#
# * `.env` - Standard "dotenv" format, as defined by [dotenv](https://github.com/motdotla/dotenv#rules).
# * `.yaml`/`.yml` - YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may
# contain any value type.
# * `.json` - JSON. Must contain a single JSON _object_ (not an array).
#
# _NOTE: The default varfile format will change 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, it is ignored.
varfiles: []
kind:
# When false, disables publishing this build to remote registries via the publish command.
allowPublish: true
# By default, builds are _staged_ in `.garden/build/<build name>` and that directory is used as the build context.
# This is done to avoid builds contaminating the source tree, which can end up confusing version computation, or a
# build including files that are not intended to be part of it. In most scenarios, the default behavior is desired and
# leads to the most predictable and verifiable builds, as well as avoiding potential confusion around file watching.
#
# You _can_ override this by setting `buildAtSource: true`, which basically sets the build root for this action at the
# location of the Build action config in the source tree. This means e.g. that the build command in `exec` Builds runs
# at the source, and for `docker-image` builds the build is initiated from the source directory.
#
# An important implication is that `include` and `exclude` directives for the action, as well as `.gardenignore`
# files, only affect version hash computation but are otherwise not effective in controlling the build context. This
# may lead to unexpected variation in builds with the same version hash. **This may also slow down code
# synchronization to remote destinations, e.g. when performing remote `docker-image` builds.**
#
# Additionally, any `exec` runtime actions (and potentially others) that reference this Build with the `build` field,
# will run from the source directory of this action.
#
# While there may be good reasons to do this in some situations, please be aware that this increases the potential for
# side-effects and variability in builds. **You must take extra care**, including making sure that files generated
# during builds are excluded with e.g. `.gardenignore` files or `exclude` fields on potentially affected actions.
# Another potential issue is causing infinite loops when running with file-watching enabled, basically triggering a
# new build during the build.
buildAtSource: false
# Copy files from other builds, ahead of running this build.
copyFrom:
- # The name of the Build action to copy from.
build:
# POSIX-style path or filename of the directory or file(s) to copy to the target, relative to the build path of
# the source build.
sourcePath:
# POSIX-style path or filename to copy the directory or file(s), relative to the build directory.
# Defaults to to same as source path.
targetPath: ''
# Specify a list of POSIX-style paths or globs that should be included as the build context for the Build, and will
# affect the computed _version_ of the action.
#
# If nothing is specified here, the whole directory may be assumed to be included in the build. Providers are
# sometimes able to infer the list of paths, e.g. from a Dockerfile, but often this is inaccurate (say, if a
# Dockerfile has an `ADD .` statement) so it may be important to set `include` and/or `exclude` to define the build
# context. Otherwise you may find unrelated files being included in the build context and the build version, which may
# result in unnecessarily repeated builds.
#
# You can _exclude_ files using the `exclude` field or by placing `.gardenignore` files in your source tree, which use
# the same format as `.gitignore` files. See the [Configuration Files
# guide](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories) for
# details.
include:
# Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the build context and
# the Build version.
#
# Providers are sometimes able to infer the `include` field, e.g. from a Dockerfile, but often this is inaccurate
# (say, if a Dockerfile has an `ADD .` statement) so it may be important to set `include` and/or `exclude` to define
# the build context. Otherwise you may find unrelated files being included in the build context and the build version,
# which may result in unnecessarily repeated builds.
#
# 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.
exclude:
# Set a timeout for the build to complete, in seconds.
timeout: 600
spec:
# 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.
shell:
# The command to run to perform the build.
#
# _Note: You may omit this if all you need is for other implicit actions to happen, like copying files from build
# dependencies etc._
#
# By default, the command is run inside the Garden build directory (under .garden/build/<build-name>). If the top
# level `buildAtSource` directive is set to `true`, the command runs in the action source directory instead. Please
# see the docs for that field for more information and potential implications. Also note that other `exec` actions
# that reference this build via the `build` field will then also run from this action's source directory.
#
# Example: `["npm","run","build"]`
command: []
# Environment variables to set when running the command.
env: {}
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.Type | Required |
|---|---|
string | Yes |
A valid name for the action. Must be unique across all actions of the same kind in your project.
Type | Required |
|---|---|
string | Yes |
A description of the action.
Type | Required |
|---|---|
string | No |
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.Type | Required |
|---|---|
object | No |
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!
Type | Required |
|---|---|
posixPath | No |
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).
Type | Required |
|---|---|
object | No |
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>
Type | Required |
|---|---|
gitUrl | string | Yes |
Example:
source:
...
repository:
...
url: "git+https://github.com/org/repo.git#v2.0"
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.
Type | Default | Required |
|---|---|---|
array[actionReference] | [] | No |
Example:
dependencies:
- build.my-image
- deploy.api
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.
Type | Default | Required |
|---|---|---|
boolean | false | No |
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.
Type | Required |
|---|---|
object | No |
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..json- JSON. Must contain a single JSON object (not an array).
NOTE: The default varfile format will change 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, it is ignored.
Type | Default | Required |
|---|---|---|
array[posixPath] | [] | No |
Example:
varfiles:
"my-action.env"
Type | Allowed Values | Required |
|---|---|---|
string | "Build" | Yes |
When false, disables publishing this build to remote registries via the publish command.
Type | Default | Required |
|---|---|---|
boolean | true | No |
By default, builds are staged in
.garden/build/<build name> and that directory is used as the build context. This is done to avoid builds contaminating the source tree, which can end up confusing version computation, or a build including files that are not intended to be part of it. In most scenarios, the default behavior is desired and leads to the most predictable and verifiable builds, as well as avoiding potential confusion around file watching.You can override this by setting
buildAtSource: true, which basically sets the build root for this action at the location of the Build action config in the source tree. This means e.g. that the build command in exec Builds runs at the source, and for docker-image builds the build is initiated from the source directory.An important implication is that
include and exclude directives for the action, as well as .gardenignore files, only affect version hash computation but are otherwise not effective in controlling the build context. This may lead to unexpected variation in builds with the same version hash. This may also slow down code synchronization to remote destinations, e.g. when performing remote docker-image builds.Additionally, any
exec runtime actions (and potentially others) that reference this Build with the build field, will run from the source directory of this action.While there may be good reasons to do this in some situations, please be aware that this increases the potential for side-effects and variability in builds. You must take extra care, including making sure that files generated during builds are excluded with e.g.
.gardenignore files or exclude fields on potentially affected actions. Another potential issue is causing infinite loops when running with file-watching enabled, basically triggering a new build during the build.Type | Default | Required |
|---|---|---|
boolean | false | No |
Copy files from other builds, ahead of running this build.
Type | Default | Required |
|---|---|---|
array[object] | [] | No |
The name of the Build action to copy from.
Type | Required |
|---|---|
string | Yes |
POSIX-style path or filename of the directory or file(s) to copy to the target, relative to the build path of the source build.
Type | Required |
|---|---|
posixPath | Yes |
POSIX-style path or filename to copy the directory or file(s), relative to the build directory. Defaults to to same as source path.
Type | Default | Required |
|---|---|---|
posixPath | "" | No |
Specify a list of POSIX-style paths or globs that should be included as the build context for the Build, and will affect the computed version of the action.
If nothing is specified here, the whole directory may be assumed to be included in the build. Providers are sometimes able to infer the list of paths, e.g. from a Dockerfile, but often this is inaccurate (say, if a Dockerfile has an
ADD . statement) so it may be important to set include and/or exclude to define the build context. Otherwise you may find unrelated files being included in the build context and the build version, which may result in unnecessarily repeated builds.You can exclude files using the
exclude field or by placing .gardenignore files in your source tree, which use the same format as .gitignore files. See the Configuration Files guide for details.Type | Required |
|---|---|
array[posixPath] | No |
Example:
include:
- my-app.js
- some-assets/**/*
Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the build context and the Build version.
Providers are sometimes able to infer the
include field, e.g. from a Dockerfile, but often this is inaccurate (say, if a Dockerfile has an ADD . statement) so it may be important to set include and/or exclude to define the build context. Otherwise you may find unrelated files being included in the build context and the build version, which may result in unnecessarily repeated builds.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.Type | Required |
|---|---|
array[posixPath] | No |
Example:
exclude:
- tmp/**/*
- '*.log'
Set a timeout for the build to complete, in seconds.
Type | Default | Required |
|---|---|---|
number | 600 | No |
Type | Required |
|---|---|
object | No |
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.
Type | Required |
|---|---|
boolean | No |
The command to run to perform the build.
Note: You may omit this if all you need is for other implicit actions to happen, like copying files from build dependencies etc.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level
buildAtSource directive is set to true, the command runs in the action source directory instead. Please see the docs for that field for more information and potential implications. Also note that other exec actions that reference this build via the build field will then also run from this action's source directory.Example:
["npm","run","build"]Type | Default | Required |
|---|---|---|
array | [] | No |
Environment variables to set when running the command.
Type | Default | Required |
|---|---|---|
object | {} | No |
The following keys are available via the
${actions.build.<name>} template string key for exec action.The name of the action.
Type |
|---|
string |
Whether the action is disabled.
Type |
|---|
boolean |
Example:
my-variable: ${actions.build.my-build.disabled}
The local path to the action build directory.
Type |
|---|
string |
Example:
my-variable: ${actions.build.my-build.buildPath}
The local path to the action source directory.
Type |
|---|
string |
Example:
my-variable: ${actions.build.my-build.sourcePath}
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.
Type | Default |
|---|---|
string | "default" |
Example:
my-variable: ${actions.build.my-build.mode}
The variables configured on the action.
Type | Default |
|---|---|
object | {} |
Type |
|---|
string | number | boolean | link | array[link] |
The full log output from the executed command. (Pro-tip: Make it machine readable so it can be parsed by dependants)
Type | Default |
|---|---|
string | "" |
Last modified 2mo ago