Hooks can be used to run commands or set environment variables pre and post
Workflows. Pre and post hooks are only executed
a single time during a Terrateam Operation. Commands are executed from the
repository checkout directory $TERRATEAM_ROOT.
Terrateam Configuration
Terrateam behavior can be configured via a config.yml. This file is located in
a directory named .terrateam at the root of your Terraform repository:
.terrateam/config.yml.
Command to run from the directory that Terrateam is operating against.
run_on
String
Run the command on step success, failure, or always. Default is success.
capture_output
Boolean
When capture_output is set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam backend for processing. Default is false.
Post
Commands to run after any hooks.
Key
Type
Description
type
String
Post-hook type: env, run.
Env
Key
Type
Description
name
String
Name of environment variable.
cmd
List
Command to use to set environment variable.
trim_trailing_newlines
Boolean
Trim trailing newlines. Default is true.
Run
Key
Type
Description
cmd
List
Command to run from the directory that Terrateam is operating against.
run_on
String
Run the command on step success, failure, or always. Default is success.
capture_output
Boolean
When capture_output is set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam backend for processing. Default is false.
Command to run from the directory that Terrateam is operating against.
run_on
String
Run the command on step success, failure, or always. Default is success.
capture_output
Boolean
When capture_output is set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam backend for processing. Default is false.
Post
Commands to run after a Plan workflow.
Key
Type
Description
type
String
Post-hook type: env, run.
Env
Key
Type
Description
name
String
Name of environment variable.
cmd
List
Command to use to set environment variable.
trim_trailing_newlines
Boolean
Trim trailing newlines. Default is true.
Run
Key
Type
Description
cmd
List
Command to run from the directory that Terrateam is operating against.
run_on
String
Run the command on step success, failure, or always. Default is success.
capture_output
Boolean
When capture_output is set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam backend for processing. Default is false.
Command to run from the directory that Terrateam is operating against.
run_on
String
Run the command on step success, failure, or always. Default is success.
capture_output
Boolean
When capture_output is set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam backend for processing. Default is false.
Post
Commands to run after a pply workflow.
Key
Type
Description
type
String
Post-hook type: env, run.
Env
Key
Type
Description
name
String
Name of environment variable.
cmd
List
Command to use to set environment variable.
trim_trailing_newlines
Boolean
Trim trailing newlines. Default is true.
Run
Key
Type
Description
cmd
List
Command to run from the directory that Terrateam is operating against.
run_on
String
Run the command on step success, failure, or always. Default is success.
capture_output
Boolean
When capture_output is set to true, command output is included in the GitHub pull request comment on a failure. Sensitive data is not masked. Be aware, this data is sent back to the Terrateam backend for processing. Default is false.
We use cookies and similar technologies to provide certain features, enhance
the user experience and deliver content that is relevant to your interests.
Depending on their purpose, analysis and marketing cookies may be used in
addition to technically necessary cookies. By clicking on "Agree and
continue", you declare your consent to the use of the aforementioned cookies.
Here
you can make detailed settings or revoke your consent (in part if necessary)
with effect for the future. For further information, please refer to our
Privacy Policy
.