HCL2: Add more documentation to path-variables (#10245)

* HCL2: Add more documentation to path-variables

Co-authored-by: Wilken Rivera <dev@wilkenrivera.com>
This commit is contained in:
Adrien Delorme 2020-11-13 11:05:57 +01:00 committed by GitHub
parent 67e2c0b83c
commit 38c50cf00e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions

View File

@ -12,3 +12,30 @@ description: |-
- `path.cwd`: the directory from where Packer was started.
- `path.root`: the directory of the input HCL file or the input folder.
## Examples
```HCL
locals {
settings_file = "${path.cwd}/settings.txt"
scripts_folder = "${path.root}/scripts"
root = path.root
}
```
## Related Functions
- [`abspath`](/docs/from-1.5/functions/file/abspath) takes a string containing
a filesystem path and converts it to an absolute path.
- [`basename`](/docs/from-1.5/functions/file/basename) returns _only_ the last
portion of a filesystem path, discarding the portion that would be returned
by `dirname`.
- [`fileset`](/docs/from-1.5/functions/file/fileset) enumerates a set of
regular file names given a path and pattern.
- [`dirname`](/docs/from-1.5/functions/file/dirname) returns all of the
segments of a filesystem path _except_ the last, discarding the portion that
would be returned by `basename`.