Update dependency terragrunt to v1#481
Open
renovate[bot] wants to merge 1 commit into
Open
Conversation
bbb2b62 to
e09bba4
Compare
b58cf0b to
3d007a1
Compare
3d007a1 to
2d09d35
Compare
810e060 to
ca5bef3
Compare
ca5bef3 to
c72ec85
Compare
c72ec85 to
1bb2f4f
Compare
1bb2f4f to
32d7a49
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.99.4→1.1.0Release Notes
gruntwork-io/terragrunt (terragrunt)
v1.1.0Compare Source
✨ New Features
Stack dependencies
A stack generates a tree of units from a single
terragrunt.stack.hclfile. Wiring one of those units to another used to mean definingdependencyblocks in your catalog and threading dependency paths throughvalues. Stack dependencies let you declare those relationships up front instead.Add an
autoincludeblock inside aunitorstackblock, and Terragrunt generates a partial configuration (aterragrunt.autoinclude.hclfile) next to the generatedterragrunt.hclorterragrunt.stack.hclthat's automatically merged into the unit or stack definition. The newunit.<name>.pathandstack.<name>.pathreferences resolve to generated paths, so you don't have to hardcode them:Anything that's valid in a unit configuration is valid in its
autoincludeblock, so you can also patch catalog units with configuration they don't ship with, like retry rules:The same works for nested stacks: an
autoincludeblock inside astackblock patches the generatedterragrunt.stack.hcl, so you can, for example, add an extra unit to one environment without forking the stack in your catalog.Stack configurations also gained two capabilities along the way:
includeblocks now work interragrunt.stack.hclfiles, so shared stack configuration can live in a parent folder.dependencyblocks can target stack directories, and the run queue expands them to the units inside. Note that this relationship only goes one way: units can depend on stacks, but stacks cannot depend on stacks or units.See the stacks documentation for the full reference. Previously gated behind the
stack-dependenciesexperiment, all of this is now enabled by default.Content Addressable Store (CAS)
The Content Addressable Store (CAS) deduplicates source downloads across configurations. It addresses repositories and modules by their content, stores them locally, and serves later requests from that local store instead of repeating the fetch. This speeds up catalog cloning, OpenTofu/Terraform source fetching, and stack generation, and identical files occupy disk space once regardless of how many configurations use them.
The CAS is no longer limited to Git. It also deduplicates HTTP, Amazon S3, Google Cloud Storage, Mercurial, and SMB sources, along with OpenTofu/Terraform registry sources fetched via
tfr://. See supported sources for how each one resolves and deduplicates content.CAS is enabled by default. Use the
--no-casflag (orTG_NO_CAS=true) to opt out of it for a run:Two new attributes give you finer control, and both default to off:
update_source_with_casmakes a generated stack self-contained. Set it on aunit,stack, orterraformblock with a relativesource, andterragrunt stack generaterewrites that source into a content-addressedcas::reference, so the generated tree no longer depends on the surrounding repository layout. Catalog authors can keep relative paths in their sources and still ship a portable, reproducible stack:After
terragrunt stack generate, the relative path is replaced by a reference to the exact tree the CAS stored:mutablecontrols how the CAS places fetched content on disk. By default, the CAS hard links files from its shared store into.terragrunt-cacheand marks them read-only, which is fast and uses no extra space, but means the files can't be edited in place. Setmutable = trueon aterraformblock to copy the content instead, making the working tree safe to edit at the cost of extra I/O and disk space:Previously gated behind the
casexperiment, the CAS no longer requires--experiment cas.Redesigned
terragrunt catalogThe
catalogcommand has been redesigned. It now starts without any configuration, discovers components across your catalog repositories in the background, and streams them into the TUI as they're found.Discovery is no longer limited to a
modules/directory; components can live anywhere in a catalog repository. To control what gets discovered, add a.terragrunt-catalog-ignorefile with.gitignore-style globs for the paths you want filtered out.Components in the TUI now carry metadata to help you navigate a large catalog: each one shows a kind label (
template,stack,unit, ormodule) and optional tags defined in the front-matter of itsREADME.md. From the component list, presssto open a new screen that interactively collects the values used to scaffold the component into your repository.Previously gated behind the
catalog-redesignexperiment, the redesigned catalog is now the defaultterragrunt catalogexperience.Reading detection for local module sources
Terragrunt can select units by the files they read, which is the basis of change-based runs in CI. Previously, pointing a unit's
terraformblock at a local directory didn't mark the files inside that directory as read, so a change to the module wouldn't select the unit.When a unit's source is a local module, Terragrunt now records the module's
*.tf,*.tf.json,*.hcl,*.tofu, and*.tofu.jsonfiles as read by that unit, so--filter 'reading=<path>'and--queue-include-units-readingselect the unit when a module file changes:terragrunt run --all --filter 'reading=./modules/vpc/main.tf' -- planFor files that reading detection doesn't track on its own, the new
mark_glob_as_read()HCL function expands a glob and marks every matching file as read in one call:Existing pipelines built on
--queue-include-units-readingorreading=filters may select more units than before, because changes to local module files now count as reads. Previously gated behind themark-many-as-readexperiment, these behaviors no longer require--experiment mark-many-as-read.Skip auth during discovery with
--no-discovery-auth-provider-cmdBy default, Terragrunt runs your
--auth-provider-cmdonce for every unit it discovers, so HCL functions that need credentials resolve correctly during parsing. In a large repository, that can mean hundreds of invocations before any unit runs, which can dominate wall-clock time on change-based runs.The
--no-discovery-auth-provider-cmdflag (env:TG_NO_DISCOVERY_AUTH_PROVIDER_CMD) skips those invocations during the discovery phase, leaving auth to run only for the units that actually execute:Previously gated behind the
opt-out-authexperiment, the flag now works without--experiment opt-out-auth.Run queue displayed as a dependency tree
Before a
run --all, Terragrunt lists the units it's about to run. That list now renders as a dependency tree by default instead of a flat list, with units nested under their dependencies, so the run order and the relationships between units are visible before anything executes:The header adapts to direction: dependencies come before dependents on apply, and the order reverses on destroy.
Previously gated behind the
dag-queue-displayexperiment, the tree display no longer requires--experiment dag-queue-display.💡 Tips Added
Tip when filtering a stack leaves nested stacks ungenerated
terragrunt stack generate --filter './my-stack | type=stack'generates only the selectedstack, not the nested stacks it contains, which can be surprising for a stack of stacks.
When a non-glob
| type=stackfilter leaves a stack's nested stacks ungenerated, Terragruntnow prints a tip showing how to generate them too, for example
--filter './my-stack | type=stack' --filter './my-stack/** | type=stack'.🐛 Bug Fixes
Fix
permission deniedwhen generated files overwrite CAS-materialized filesWith the CAS enabled, Terragrunt fetches sources as read-only files. Writing a generated file over one of them no longer fails with
permission denied:generateblocks withif_exists = "overwrite", when the module ships the target file (for example, its ownversions.tf).terragrunt.values.hcl, when the unit or stack source already contains one.terragrunt.autoinclude.hcl, when the unit or stack source already contains one..terraform.lock.hcl, when the provider cache server updates a committed lock file duringinit -upgrade.In each case, the read-only file is replaced with a writable one, and the shared CAS store is never modified.
Fix
permission deniedwhen CAS fetches a git source across filesystemsWith the CAS enabled, fetching a
git::source could fail withpermission deniedon.git/HEADor.git/config, sending Terragrunt back to the standard getter. It happened when the CAS store and the module's working directory sit on different filesystems, so the files are copied rather than hard-linked, and a read-only leftover from an interrupted run was in the way. Terragrunt now recovers from the leftover and completes the fetch.Reject
update_source_with_cason aterraformblock when CAS is disabledterragrunt stack generate --no-casnow fails when a generated unit'sterraformblock setsupdate_source_with_cas = true, instead of silently emitting the unit with its relativesourceunchanged. The relative source has no meaning once CAS is disabled, so the generated unit could not resolve its module. This matches the existing behavior for the same attribute onunitandstackblocks, and for aruninvoked with--no-cas.Apply
extra_argumentsenv vars when resolvingdependencyoutputsResolving a
dependencyblock's outputs now applies theenv_varsfrom the unit'sterraformextra_argumentsblocks whosecommandsincludeoutput.Resolve
dependencyoutputs for units whosebefore_hookreferences a dependencyResolving a unit's
dependencyoutputs no longer evaluates that unit'sterraformhooks, so abefore_hook(orafter_hook) that interpolates${dependency.<name>.outputs.<key>}no longer fails downstream units withThere is no variable named "dependency". Dependency output resolution still applies the unit'sextra_argumentsenv_varsandsource.Select units reading added or deleted glob files in Git-based filters
Git-based filters (for example
terragrunt run --all --filter '[HEAD^1...HEAD]' -- plan) now select unitsthat read an added or deleted file through
mark_glob_as_read, even when that file lives outside the unit'sown directory. Previously only modified files outside a unit reached those units; adding or deleting a file
the glob matched left the reading unit out of the run, so its real config change was skipped. Added files are
matched against the newer reference, and deleted files against the older one where the file still exists.
mark_glob_as_readconstrains its walk to a boundarymark_glob_as_readnow confines glob expansion to a boundary directory. By default the boundary is the enclosing Git repository root; outside a Git repository it is unset. A pattern whose walk would begin outside the boundary returns an error instead of expanding.This bounds patterns that resolve higher than intended. For example,
"${local.dir}/{*.yaml}"becomes/{*.yaml}whenlocal.diris empty, which previously walked the entire filesystem. A? :conditional does not prevent this, because HCL evaluates both branches of a conditional before selecting one. Wrapping the call intrylets the error fall back to a default:Pass a leading
--terragrunt-boundaryargument to set the boundary explicitly, for example to scope the walk to a subdirectory or to widen it to the filesystem root:Scaffold only detects variables in the module directory
terragrunt scaffoldnow reads input variables from the module directory itself, matching what OpenTofu and Terraform load for a root module. Previously it scanned subdirectories too, sovariableblocks defined in nested modules or examples leaked into the scaffolded inputs even though the module never exposes them.Resolve interpolated object keys in autoinclude blocks
terragrunt stack generatenow resolves interpolated object keys inautoincludeblocks (for example{ "${local.prefix}_key" = ... }), even when the value referencesdependency.*. Previously the generatedunit kept the key verbatim, leaking a stack-only reference that is not valid in the unit scope.
Fix panic on non-string literal interpolation in
autoincludetemplatesterragrunt stack generateno longer panics when anautoincludetemplate interpolates a non-string literal (for example"${0}"or"${true}") alongside adependency.*reference. The interpolated literal is now rendered to its string form (${0}becomes0) and the dependency reference is preserved for the unit.Resolve transitive
autoincludedependencies on a stack directoryrun --allno longer fails with "does not contain a terragrunt.hcl file" when anautoincludedependency points at a stack directory (one holdingterragrunt.stack.hcl) and the unit is reached transitively through another unit. The dependency cycle check now skips a target with no unit config, matching the direct dependency case.🧪 Experiments Updated
Six experiments completed
The following experiments graduated to general availability in this release, and the features they gated are now enabled by default:
stack-dependenciescascatalog-redesignmark-many-as-readopt-out-authdag-queue-displayEach feature is described in the New Features section above.
The corresponding
--experimentflags (andTG_EXPERIMENTvalues) are no longer needed. Passing one still works, but emits a warning about the completed experiment, so you can drop it at your convenience.Thank you to everyone who ran these experiments early and filed the feedback that got them here.
⚙️ Process Updates
Immutable releases
Starting with this release, Terragrunt releases are published as immutable releases on GitHub. Once a release is published, its tag and assets can no longer be modified or deleted, so the binary you download is guaranteed to be the same binary that was uploaded when the release was published.
See the releases process documentation for details, and Verifying releases with the GitHub CLI for how to check a download against the release attestation.
Install script verifies release attestations
The install script now checks downloaded release assets against the release attestation that ships with immutable releases. For releases starting with
v1.1.0, when an authenticated GitHub CLI (v2.81.0 or later) is available, the script verifies the checksums file and the binary against the attestation before installing, and aborts if either does not match the published release. The check is skipped with a warning whenghis unavailable, too old, or unauthenticated. Use--no-verify-attestationto opt out.Pull Requests
✨ Features
🐛 Bug Fixes
update_source_with_casintegration with--no-casby @yhakbar in #6363--terragrunt-boundarytomark_glob_as_readby @yhakbar in #6351📖 Documentation
--parallelismtweaking considerations better by @yhakbar in #6313v1.1.0changelog polish by @yhakbar in #6333🧹 Chores
mark-many-as-readexperiment by @yhakbar in #6310casexperiment by @yhakbar in #6254dag-queue-displayexperiment by @yhakbar in #6320opt-out-authexperiment by @yhakbar in #6321go-gitby @yhakbar in #6325catalog-redesignexperiment by @yhakbar in #6271lllby @yhakbar in #6377TestWindowsTflintIsInvokedby @yhakbar in #6382lll#2 by @yhakbar in #6385go fix ./...by @yhakbar in #6398renderlog to adebugby @yhakbar in #6429📝 Other Changes
v1.0.8Compare Source
🏎️ Performance Improvements
Faster read-file tracking with the
mark-many-as-readexperimentWith the
mark-many-as-readexperiment enabled, Terragrunt records every module file it marks as read during parsing. The bookkeeping for that record scaled quadratically: each new path was checked against every path recorded so far, which got expensive for units with large local module sources, and monorepos paid that cost again for every unit and every command.Recording a path now takes constant time no matter how many paths came before it, and re-marking already-recorded files is cheaper still. The
readinglists reported byfindandlistare unchanged.🐛 Bug Fixes
assume_role: preserve commas inside list expressionsTerragrunt previously failed to correctly parse
assume_roleattributes containing list values such astransitive_tag_keysorpolicy_arns. Commas inside nested list expressions were incorrectly treated as top-level separators, causing generated configurations to fail with parsing errors.This resulted in errors similar to:
Terragrunt now preserves commas inside nested list and object expressions when parsing
assume_roleblocks, allowing configurations containing array attributes to be processed correctly.Thanks to @Rahul-Kumar-prog for contributing this fix!
Completed experiments now evaluate as permanently enabled
Features gated behind a completed experiment were treated as disabled instead of permanently enabled, so functionality that graduated out of experiment status could silently stop working.
The one affected code path was
hcl validate --inputswith a git filter expression such as--filter '[HEAD~1...HEAD]': after thefilter-flagexperiment completed, the command stopped preparing git worktrees for the filter. Git filter expressions now work withhcl validate --inputsagain, matchingfind,list, and the other commands that accept filters.Exposed-include resolution errors now name the include block, file, and failing field
When resolving an
includeblock withexpose = true, Terragrunt surfaced low-level parsing or conversion errors with no indication of which include block, file, or field was at fault. This was especially hard to debug for errors that carry no source location, such as:The error is now annotated with the include block name, the included (parent) file path, and a single dotted locator for the failing field — the top-level config field (
dependency,inputs,locals, orfeature) plus the attribute path within it when go-cty can determine one:When go-cty cannot resolve a precise attribute path, the locator degrades to just the field name:
Errors that originate in HCL parsing already carry a source range (
file:line:column) and are preserved unchanged. This narrows the search from the entire configuration tree to a specific file and field.Intersecting a graph traversal with another filter no longer drops the traversed components
A graph traversal combined with an intersected filter dropped the components reached in discovery.
e.g.,
...a-dependent | type=unit(the dependents ofa-dependent, intersected with type ofunits) returned onlya-dependentitself instead of its dependents, and git-change traversals such as...[HEAD~1...HEAD] | type=unitlost the dependents of the changed units.A component that matched both a graph expression target and a positive filesystem or git filter was classified as discovered before the graph traversal ran, so the traversal never expanded from it. Terragrunt now checks graph expression targets first, so intersecting a traversal with another filter keeps the dependencies and dependents it reaches.
generateblocks now honorhcl_fmtTerragrunt now accepts
hcl_fmtongenerateblocks and preserves the setting when configurations are parsed, written, and parsed again. This lets generated.tf,.hcl, and.tofufiles opt out of automatic HCL formatting by settinghcl_fmt = false, matching the existinggenerate = { ... }attribute-map behavior.Telemetry resource now honors
OTEL_SERVICE_NAMEandOTEL_RESOURCE_ATTRIBUTESTerragrunt previously hardcoded the
service.nameresource attribute toterragruntfor every emitted trace and metric, ignoring the standard OpenTelemetry environment variables. Multiple Terragrunt invocations could not be distinguished in an OpenTelemetry backend without an intermediate collector to rewrite the attribute.The resource is now composed via
resource.NewwithWithFromEnv()placed after Terragrunt's defaults, soOTEL_SERVICE_NAMEandOTEL_RESOURCE_ATTRIBUTESare honored on every span and metric. Per the OpenTelemetry specification,OTEL_SERVICE_NAMEtakes precedence over aservice.nameentry inOTEL_RESOURCE_ATTRIBUTES. The defaultservice.nameremainsterragruntwhen neither variable is set.s3::sources: support virtual-hosted-style URLss3::source URLs using the virtual-hosted-style S3 endpoint format were rejected:This resulted in errors like:
Terragrunt now accepts every AWS S3 endpoint form, including virtual-hosted-style URLs (
<bucket>.s3.<region>.amazonaws.com) and modern path-style URLs (s3.<region>.amazonaws.com).Windows console mode is restored when Terragrunt exits
On Windows, running a Terragrunt command from Nushell could leave the shell unable to read input afterward, with keystrokes such as the arrow keys appearing as raw escape sequences instead of being interpreted.
While it runs, Terragrunt reconfigures the console it shares with the parent shell so that terminal escape sequences are processed, but it did not put the original mode back when it exited. PowerShell reapplies its own console settings on every prompt and recovers on its own, so the problem surfaces only in shells that keep the inherited mode, such as Nushell. Terragrunt now records the console mode at startup and restores it on exit, returning the shell to the state it was in beforehand.
Reported in #6245.
📖 Documentation Updates
Clean Markdown is available for every docs page at
<url>.mdEvery docs page is now served as clean Markdown at the same URL with
.mdappended. For example,/getting-started/installis also available at/getting-started/install.md.The
.mdversion contains the page content without the site navigation or other surrounding HTML, which makes it well suited as context for LLMs and AI tooling: it is smaller and carries only the documentation itself. Coverage includes every page, including the CLI command reference and the changelog.This complements the existing
llms.txtandllms-full.txtfiles by providing a per-page Markdown source.🧪 Experiments Added
optional-hooks— Add experimental --no-hooks flag support for terragrunt runThe terragrunt
runcommand now supports an experimental--no-hooksflag for disabling hook execution during command runs.The feature is gated behind the
optional-hooksexperiment and skips execution ofbefore_hook,after_hook, anderror_hookblocks when enabled.This feature is currently experimental because disabling hooks changes Terragrunt execution semantics and may evolve in future releases.
Using
--no-hookswithout enabling theoptional-hooksexperiment will return an error.hook-context-envexperiment exposes additionalTG_CTX_*env vars to hooksEnable the new
hook-context-envexperiment to surface three additional environment variables to everybefore_hook,after_hook, anderror_hook:TG_CTX_HOOK_TYPE—before_hook,after_hook, orerror_hook, identifying which lifecycle phase invoked the hook.TG_CTX_SOURCE— the resolved terraform source URL (CLI--sourceoverride, else evaluatedterraform.sourcewith source-map applied, else.).TG_CTX_TERRAGRUNT_DIR— the directory of the current Terragrunt config.These variables make it easier to share a single hook script across lifecycle phases and to access the unit's source and config directory without threading them through hook arguments.
🧪 Experiments Updated
cas: fallbacks now emit telemetryWhen the
casexperiment is enabled and a CAS operation cannot complete, Terragrunt falls back to a slower path (the standard download client, or a temporary clone when the shared git store is unavailable) and keeps going. Until now the only record of a fallback was a warning in the logs, which made it impractical to measure how often CAS degrades across a fleet.Each fallback now also emits a
cas_fallbacktelemetry event whosereasonattribute identifies the cause:init_error,getter_error,git_store_unavailable,probe_failure, orstack_generation_error. Operators collecting OpenTelemetry traces or metrics from Terragrunt can count and alert on these events to judge CAS health before relying on it by default.CAS flags for the
catalogcommandThe
catalogcommand now accepts the--no-casand--cas-clone-depthflags, which were already available onrun,stack generate, andstack run. When--no-casis set, catalog repositories are cloned with plain Git even if thecasexperiment is enabled.--cas-clone-depthcontrols thegit clone --depthvalue the CAS uses when cloning catalog repositories.cas—update_source_with_casrequires a literal source stringWhen a catalog
unit,stack, orterraformblock setupdate_source_with_cas = truewith asourcethat was not a literal string, rewriting silently produced a wrong source. Interpolation such as"../units/${local.name}"had the interpolated portion dropped, leaving a bare prefix; a reference such aslocal.fooresolved to the directory containing the block itself. In both cases stack generation packaged the wrong directory without any error.Stack generation now fails with an error explaining that
update_source_with_casrequires a literal source string. Non-literal expressions, including interpolation, function calls, and references likelocal.foo, are rejected.cas— Malformedcas::references fail with a clear errorA
cas::source with a malformed hash, such ascas::sha1:a, used to fail with an opaque internal error while looking the hash up in the store.CAS references are now validated up front: the hash must be lowercase hexadecimal with exactly 40 characters for
sha1or 64 forsha256. References that don't match are rejected with an error identifying the bad reference.cas— Repositories with submodules now clone correctlyCloning a repository that contains git submodules through the Content Addressable Store failed while ingesting the repository:
A submodule appears in the repository tree as a pointer to a commit in another repository, so the object behind it cannot be read from the repository being cloned.
The CAS now fetches each submodule from the URL registered in
.gitmodulesat its pinned commit and materializes its contents in place, including nested submodules. Relative submodule URLs (such as../sibling.git) are resolved against the parent repository URL, matching git's behavior. Submodule contents are stored and deduplicated like any other content, so repeated clones reuse the cache.catalog-redesign— Failures now exit nonzero and name the sources that failedThe redesigned catalog exited with code 0 even when it failed: a session that ended on an unreachable repository, a failed scaffold, or a failed copy reported success in its exit code. Repositories that failed to load during discovery were dropped too: the warning logged for each one was drawn over by the full-screen interface, so a run where every source failed showed the same "No catalog sources were discovered" screen as a run that genuinely found nothing.
The catalog now exits nonzero when the session ends on a failure: a discovery failure that leaves nothing to browse, a failed scaffold, or a failed copy. Quitting a working session still exits 0. When some sources fail to load while others succeed, the catalog stays usable and a clean quit still exits 0; the component list shows how many sources failed, and the failed repositories are printed with their causes after the catalog closes. When every source fails, the error screen lists each failed repository instead of claiming nothing was found, and dismissing it exits nonzero.
Running
terragrunt catalogwithout an interactive terminal, such as in CI, used to fail with a raw error from the underlying TUI library:It now fails immediately with an error stating that the catalog command requires an interactive terminal.
catalog-redesign— Scaffolding a component no longer fails with a path-traversal errorScaffolding a component from the catalog (pressing
s) could fail on macOS while downloading the source:The catalog caches each repository under the system temporary directory, which macOS reports through a symlink (
/var/folders/...pointing at/private/var/folders/...). The source location Terragrunt handed to the downloader was built against the unresolved path, so it pointed outside the cached repository and was rejected.Terragrunt now resolves the temporary directory before discovering components, so the source stays inside the repository and scaffolding proceeds.
stack-dependencies: HCL tooling now handlesautoincludeTwo tooling gaps around the experimental
autoincludeblock are closed:hcl validatenow validatesautoincludeblocks. With thestack-dependenciesexperiment enabled, validating aterragrunt.stack.hclthat declaresautoincluderuns the same strict checks asterragrunt stack generate. A malformed block (for example, alocalsblock insideautoinclude) is now reported at validation time instead of passinghcl validateand only failing later during generation. Without the experiment, validation behavior is unchanged.read_terragrunt_config()can read stack-level autoinclude files. Reading a generatedterragrunt.autoinclude.stack.hclpreviously failed because the file was decoded as a unit configuration, which rejects itsunitandstackblocks. With the experiment enabled, the file is now decoded as the stack-file fragment it is, returning itsunitandstackblocks the same way reading aterragrunt.stack.hcldoes. Unit-levelterragrunt.autoinclude.hclfiles already read correctly and continue to do so.stack-dependencies:autoincludemerges like a regular includeA generated unit autoinclude (
terragrunt.autoinclude.hcl) now merges into the unit's config using the same default merge as a regularinclude, which is a shallow merge, applied uniformly across generation, full parse, and discovery. Top-level keys from the unit and the autoinclude combine, and on a conflict the autoinclude wins and replaces the unit's value rather than deep-merging nested maps;localsstay local in scope.A generated stack autoinclude (
terragrunt.autoinclude.stack.hcl) injectsunitandstackblocks into the generatedterragrunt.stack.hcl. An injected block whose name matches an existingunitorstacknow overrides that block wholesale, consistent with unit autoinclude override semantics, and an injected block with a new name is added. This applies uniformly across generation, full parse, and discovery, so a name match no longer produces a duplicate-name error. A stack autoinclude may not declare a top-leveldependencyblock (stacks have no dependencies; declare the dependency inside the target unit's own autoinclude).A
dependencyblock injected through anautoincludeis now available before a unit'sremote_stateis evaluated, so referencingdependency.<name>.outputs.<key>there no longer fails.remote_statenow behaves the same asgenerateblocks.stack-dependencies:autoincludeblocks can referencevalues.*An
autoincludeblock may now reference the stack'svalues.*. Previously avalues.*reference was rejected at stack generate time, except in a dependencyconfig_path. It now resolves to a literal likelocal.*,unit.<name>.path, andstack.<name>.path, wherever it appears:inputs,generate,remote_state,mock_outputs, andconfig_path.Function calls in an autoinclude now resolve at generate time too, in the
terragrunt.stack.hclcontext, instead of being kept verbatim and evaluated in the generated unit. Only adependency.*reference (a dependency's outputs) stays verbatim and resolves inside the unit; in a mixed expression the stack-level parts resolve and only thedependency.*reference is kept.Because functions now evaluate against the stack file rather than the unit, directory and include functions report the stack file's location:
get_terragrunt_dirreturns the stack file's directory, andpath_relative_to_includereturns".". If you relied on these resolving in the unit, move them to the unit's own configuration, or derive a per-unit value such as aremote_statebackend key fromunit.<name>.path.A
localsblock inside an autoinclude remains rejected; declare stack-level locals interragrunt.stack.hclinstead.stack-dependencies: stack dependencies resolvevalues.*in the target stack's localsExpanding a dependency that points at a generated stack directory no longer fails when that stack's
terragrunt.stack.hclreadsvalues.*in itslocalsblock. Previously,terragrunt stack generatesucceeded butterragrunt run --allthen failed withThere is no variable named "values"while expanding the dependency into its units.Dependency expansion now reads the generated
terragrunt.values.hclnext to eachterragrunt.stack.hclit visits, including nested stacks, so each nesting level resolvesvalues.*from its own values file, the same way a full stack parse does.stack-dependencies: component path references invaluesno longer break next toautoincludeblocksA
unitorstackblock'svaluescan referenceunit.<name>.pathandstack.<name>.patheven when another block in the sameterragrunt.stack.hcldeclares anautoinclude. Previously, the presence of anyautoincludeblock madestack generatereject those references withUnknown variable; There is no variable named "unit", while the same file without anautoincludegenerated fine.Pull Requests
✨ Features
🐛 Bug Fixes
OTEL_SERVICE_NAMEandOTEL_RESOURCE_ATTRIBUTESenvironment variables by @Tensho in #6256terragrunt.stack.hclfiles by @yhakbar in #6291autoincludeinhcl validateand fixread_terragrunt_config()for configurations usingautoincludeby @yhakbar in #6297📖 Documentation
completedSinceby @yhakbar in #6252.mdchangelog files by @yhakbar in #6286autoincludedocumentation by @yhakbar in #6299🧹 Chores
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.