Skip to content

Commit

Permalink
bt: Update README and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidGamba committed Dec 6, 2023
1 parent 72b60a6 commit cd9b7b7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion bt/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -173,18 +173,22 @@ When using `bt terraform workspace-select default` bt will automatically delete

== Pre Apply Checks

When using `bt terraform build`, pre apply checks get run automatically after a plan if they are enabled.

Pre apply check commands get the following Env vars exported:

* `CONFIG_ROOT`: The dir of the config file.
* `TERRAFORM_JSON_PLAN`: The path to the rendered json plan.

If pre-apply checks are enabled in the config file, they can be disabled for the current run using the `--no-checks` option.

To run only the checks, use `bt terraform checks`, combine it with the `--ws` option to run the checks against the last generated plan for the given workspace.

== Profiles

Multiple terraform config profiles can be defined.
By default, the `default` profile is used.
The default profile can be overriden with `config.default_terraform_profile` in the config file.
The default profile can be overridden with `config.default_terraform_profile` in the config file.

To use a different profile, use the `--profile` option or export the `BT_TERRAFORM_PROFILE` environment variable.
The environment variable can also be overridden to read an existing one in the environment.
Expand Down
2 changes: 2 additions & 0 deletions bt/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This eases using Terraform with and without bt.
+
When switching to the default workspace, bt automatically removes the environment file so that we are not locked into a specific workspace.

* Expose terraform checks command as a standalone command to allow running pre-apply checks.

== v0.3.0: Breaking changes

Terraform config has been updated to support multiple profiles.
Expand Down

0 comments on commit cd9b7b7

Please sign in to comment.