Skip to content

Commit abdb1eb

Browse files
feat: tg version compatibility table (#2418)
* feat: tg version compatibility table * subs * Update docs/2.0/docs/pipelines/guides/file-dependencies.md Co-authored-by: Oreoluwa Agunbiade <[email protected]> --------- Co-authored-by: Oreoluwa Agunbiade <[email protected]>
1 parent b6ba3b1 commit abdb1eb

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

docs/2.0/docs/pipelines/guides/file-dependencies.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ However, there are some cases where you may want to run Pipelines for changes to
66

77
## Configuration
88

9+
:::note
10+
11+
This feature is available when using Pipelines with Terragrunt version 0.68.13 and later.
12+
13+
:::
14+
915
Pipelines will automatically detect, based on git commit history, when data files have changed and emit a `FileChanged` change. This will create a new execution in your CI flow that will invoke Terragrunt with the [`queue-include-units-reading`](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-include-units-reading) option set to the files that have changed. Terragrunt will then scan your code for units that depend on the changed files and add them to the plan/apply.
1016

1117
Note that Terragrunt will only be able to determine which units read the data file if that file is read using a built-in function such as `read_terragrunt_config` or is in a `include`, `dependency`, or `dependencies` block. You may want to use the [`mark_as_read`](https://terragrunt.gruntwork.io/docs/reference/built-in-functions/#mark_as_read) function to explicitly ensure that Terragrunt knows to include your unit when a particular data file is changed.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Terragrunt Version Compatibility
2+
3+
| Type | Terragrunt Version | Pipelines Version | Comments |
4+
| ----------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5+
| Recommended | 0.68.13+ | v3.y.z | Pipelines uses new features in Terragrunt to provide enhanced logging, and the [File Dependency](https://docs.gruntwork.io/2.0/docs/pipelines/guides/file-dependencies) feature |
6+
| Minimum | 0.59.7 | v3.y.z | This is the absolute minimum version of terragrunt for pipelines v3 |
7+
| Minimum | 0.59.7 | v2.y.z | |

sidebars/reference.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ const sidebar = [
2727
type: "doc",
2828
id: "2.0/reference/pipelines/index",
2929
},
30+
{
31+
label: "Terragrunt Version Compatibility",
32+
type: "doc",
33+
id: "2.0/reference/pipelines/terragrunt-version-compatibility",
34+
},
3035
{
3136
label: "Configurations (YAML)",
3237
type: "doc",

0 commit comments

Comments
 (0)