From 2a292340d93bde25aa3ed68af2ed739b3c99207f Mon Sep 17 00:00:00 2001 From: Pam Selle <204372+pselle@users.noreply.github.com> Date: Wed, 16 Oct 2019 10:15:50 -0400 Subject: [PATCH] Add website docs --- website/docs/backends/types/remote.html.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/website/docs/backends/types/remote.html.md b/website/docs/backends/types/remote.html.md index d4320e810b..199ac5a1bc 100644 --- a/website/docs/backends/types/remote.html.md +++ b/website/docs/backends/types/remote.html.md @@ -166,3 +166,25 @@ The following configuration options are supported: workspace names are used in Terraform Cloud, and the short names (minus the prefix) are used on the command line. If omitted, only the default workspace can be used. This option conflicts with `name`. + +## Excluding Files from Upload with .terraformignore + +-> **Version note:** `.terraformignore` support was added in Terraform 0.12.11. + +When executing a remote `plan` or `apply` in a [CLI-driven run](/docs/cloud/run/cli.html), +an archive of your configuration directory is uploaded to Terraform Cloud. You can define +paths to ignore from upload via a `.terraformignore` file at the root of your configuration directory. If this file is not present, the archive will exclude the following by default: + +* .git/ directories +* .terraform/ directories (exclusive of .terraform/modules) + +The `.terraformignore` file can include rules as one would include in a +[.gitignore file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#Ignoring-Files) + + +* Comments (starting with `#`) or blank lines are ignored +* End a pattern with aforward slash / to specify a directory +* Negate a pattern by starting it with an exclamation point `!` + +Note that unlike `.gitignore`, only the `.terraformignore` at the root of the configuration +directory is considered.