Skip to content

Commit fe2077a

Browse files
committed
Update README
1 parent bcb2c3a commit fe2077a

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,12 @@ include = {
356356
}
357357
```
358358

359-
When you run Terragrunt, it will see the `include` block and load the contents of the root `.terragrunt` file, almost
360-
as if you had copy/pasted the contents of the root `.terragrunt` file into `qa/my-app/.terragrunt`.
359+
When you run Terragrunt in the `qa/my-app` folder, it will see the `include` block in the `qa/my-app/.terragrunt` file
360+
and realize that it should load the contents of the root `.terragrunt` file instead. It's almost as if you had
361+
copy/pasted the contents of the root `.terragrunt` file into `qa/my-app/.terragrunt`, but much easier to maintain!
362+
363+
**Note**: only one level of includes is allowed. If `root/qa/my-app/.terragrunt` includes `root/.terragrunt`, then
364+
`root/.terragrunt` may NOT specify an `include` block.
361365

362366
There are a few problems with the simple approach above, so read on before using it!
363367

@@ -392,10 +396,6 @@ no changes.
392396
`find_in_parent_folders()` will search up the directory tree until it hits the root folder of your file system, and if
393397
no `.terragrunt` file is found, Terragrunt will exit with an error.
394398

395-
**Note**: only one level of includes is allowed. If `foo/bar/.terragrunt` includes `foo/.terragrunt`, then
396-
`foo/.terragrunt` may NOT itself specify an `include` block. Otherwise, reasoning about helper functions such as
397-
`path_relative_to_include()` gets too complicated.
398-
399399
### path_relative_to_include helper
400400

401401
Another helper function supported by Terragrunt is `path_relative_to_include()`, which returns the relative path between

0 commit comments

Comments
 (0)