Skip to main content

Overview

A .terrateam/config.yml file can be used to configure all available Terrateam options.

This configuration file is not required to use Terrateam.

tip

Terrateam defaults are acceptable for most use cases.

Both the yml and yaml file extensions are supported.

The filenames are case sensitive and must be lowercase.

Default Configuration

##########################################################################
# THIS FILE SHOULD LIVE IN .terrateam/config.yml
#
# See https://docs.terrateam.io/configuration/overview for details
##########################################################################
enabled: true
version: "1"
parallel_runs: 3
when_modified:
file_patterns: ["**/*.tf", "**/*.tfvars"]
autoplan: true
autoapply: false
automerge:
enabled: false
delete_branch: false
checkout_strategy: merge
cost_estimation:
enabled: true
provider: infracost
currency: USD
default_tf_version: latest
hooks:
plan:
pre: []
post: []
apply:
pre: []
post: []
workflows:
dirs:

Top-Level Keys

KeyTypeDescription
enabledboolSpecified whether the repository is enabled. If set to false, all events from this repository will be ignored.
versionstringConfiguration file version number
when_modifiedobjectFile pattern definitions used for evaluating automatic command executions
automergeobjectAutomerge the pull request after a successful terrateam apply
hooksobjectCustom commands to execute before and after Workflows
workflowsobjectOverride default terraform commands used in terrateam plan and terrateam apply
checkout_strategystringHow Terrateam performs a code checkout from the pull request
parallel_runsintNumber of terraform operations that can run at the same time
dirsobjectConfiguration for mapping directories with tags, workspaces, and when_modified
cost_estimationobjectCost estimation configuration
default_tf_versionstringGlobal terraform version