»fileset Function

fileset enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (/) as the path separator for cross-system compatibility.

fileset(path, pattern)
fileset(path, pattern)

Supported pattern matches:

  • * - matches any sequence of non-separator characters
  • ** - matches any sequence of characters, including separator characters
  • ? - matches any single non-separator character
  • {alternative1,...} - matches a sequence of characters if one of the comma-separated alternatives matches
  • [CLASS] - matches any single non-separator character inside a class of characters (see below)
  • [^CLASS] - matches any single non-separator character outside a class of characters (see below)

Character classes support the following:

  • [abc] - matches any single character within the set
  • [a-z] - matches any single character within the range

Functions are evaluated by the CLI during configuration parsing rather than job run time, so this function can only be used with files that are already present on disk on operator host.

»Examples

> tree pkr-consul
pkr-consul
├── build-linux.pkr.hcl
└── linux
    ├── files
    │   ├── hello.txt
    │   └── world.txt
    └── scripts
        ├── script-1-install.sh
        └── script-2-setup.sh

3 directories, 5 files

> fileset(".", "*")
[
  "build-linux.pkr.hcl",
]

> echo 'fileset(".", "linux/scripts/*")'
[
  "linux/scripts/script-1-install.sh",
  "linux/scripts/script-2-setup.sh",
]

> echo 'fileset("linux", "files/{hello,world}.txt")'
[
  "files/hello.txt",
  "files/world.txt",
]

> echo 'fileset("./linux/files", "*")'
[
  "hello.txt",
  "world.txt",
]

> echo 'fileset("./linux", "**")'
[
  "files/hello.txt",
  "files/world.txt",
  "scripts/script-1-install.sh",
  "scripts/script-2-setup.sh",
]
> tree pkr-consulpkr-consul├── build-linux.pkr.hcl└── linux    ├── files    │   ├── hello.txt    │   └── world.txt    └── scripts        ├── script-1-install.sh        └── script-2-setup.sh
3 directories, 5 files
> fileset(".", "*")[  "build-linux.pkr.hcl",]
> echo 'fileset(".", "linux/scripts/*")'[  "linux/scripts/script-1-install.sh",  "linux/scripts/script-2-setup.sh",]
> echo 'fileset("linux", "files/{hello,world}.txt")'[  "files/hello.txt",  "files/world.txt",]
> echo 'fileset("./linux/files", "*")'[  "hello.txt",  "world.txt",]
> echo 'fileset("./linux", "**")'[  "files/hello.txt",  "files/world.txt",  "scripts/script-1-install.sh",  "scripts/script-2-setup.sh",]