Skip to content

mark_glob_as_read

unitstack

Usage

mark_glob_as_read(pattern: string) --> list(string)

mark_glob_as_read records each matching file as read, like mark_as_read, so reading= filters such as --filter 'reading=./config/**' find the unit when any of them changes. It returns the matches as absolute paths, or an empty list when nothing matches:

terragrunt.hcl
locals {
configs = mark_glob_as_read(
"${get_terragrunt_dir()}/config/{*.yaml,**/*.yaml}",
)
}
inputs = {
configs = [for f in local.configs : yamldecode(file(f))]
}

Pattern syntax

Patterns follow gobwas/glob:

  • * matches within one path segment.
  • ** matches any sequence of characters, including /.
  • ? matches one character other than /.
  • [abc] matches one character in the class.
  • {a,b} matches any of the alternatives.
  • \ escapes the next character.

Separate path segments with /, even on Windows, since \ escapes.

** stands for directories only between literal segments. config/**/*.yaml matches files in subdirectories of config, but not files directly in it. Use config/{*.yaml,**/*.yaml} for both.

Boundary

mark_glob_as_read fails when a pattern starts outside its boundary directory, so a pattern built from an empty value can’t scan the whole filesystem. For example, "${local.dir}/{*.yaml}" becomes /{*.yaml} when local.dir is "". The boundary is the root of the Git repository, and outside a Git repository there is none.

To set the boundary, pass --terragrunt-boundary first. A relative directory resolves from the unit’s directory:

terragrunt.hcl
locals {
# Allow only files under /etc/terragrunt.
scoped = mark_glob_as_read(
"--terragrunt-boundary=/etc/terragrunt",
"/etc/terragrunt/{*.yaml}",
)
# Allow any directory.
everything = mark_glob_as_read("--terragrunt-boundary=/", "/{*.yaml}")
}

HCL evaluates both branches of a ? : conditional, so a guard such as local.dir != "" ? mark_glob_as_read(...) : [] doesn’t skip the call. Wrap the call in try to fall back when it fails:

terragrunt.hcl
locals {
files = sort(try(mark_glob_as_read("${local.dir}/{*.yaml,*.yml,*.json}"), []))
}

Parameters

patternstring

The glob to expand. A relative pattern resolves from the unit’s directory. To set the boundary, pass --terragrunt-boundary=<dir> before it.

Examples

terragrunt.hcl
locals {
configs = mark_glob_as_read("${get_terragrunt_dir()}/config/*.yaml")
# ["/home/me/infra/app/config/a.yaml",
# "/home/me/infra/app/config/b.yaml"]
}