Merge pull request #31545 from hashicorp/module-invocation-warning

Add note about module.path and local module sources
This commit is contained in:
Laura Pacilio 2022-08-01 17:19:07 -04:00 committed by GitHub
commit aecbaecff5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -118,14 +118,15 @@ to mark the reference as for a data resource.
### Filesystem and Workspace Info
* `path.module` is the filesystem path of the module where the expression
is placed.
* `path.root` is the filesystem path of the root module of the configuration.
* `path.cwd` is the filesystem path of the current working directory. In
The following values are available:
- `path.module` is the filesystem path of the module where the expression is placed. We do not recommend using `path.module` in write operations because it can produce different behavior depending on whether you use remote or local module sources. Multiple invocations of local modules use the same source directory, overwriting the data in `path.module` during each call. This can lead to race conditions and unexpected results.
- `path.root` is the filesystem path of the root module of the configuration.
- `path.cwd` is the filesystem path of the current working directory. In
normal use of Terraform this is the same as `path.root`, but some advanced
uses of Terraform run it from a directory other than the root module
directory, causing these paths to be different.
* `terraform.workspace` is the name of the currently selected
- `terraform.workspace` is the name of the currently selected
[workspace](/language/state/workspaces).
Use the values in this section carefully, because they include information