Skip to content

Commit 56b4ec8

Browse files
Add documentation on IGNORE_UNITS_WITHOUT_ENVIRONMENT (#2860)
1 parent 949cede commit 56b4ec8

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

docs/2.0/reference/pipelines/feature-flags.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,31 @@ This behavior will likely become the default in a major release of Pipelines but
6464
</li>
6565
</ul>
6666

67-
#### `PIPELINES_FEATURE_EXPERIMENT_MINIMIZE_BLAST_RADIUS`
67+
#### `PIPELINES_FEATURE_EXPERIMENT_DISABLE_PREFLIGHT_AHEAD_OF_DEPLOY_BRANCH`
6868
<ul>
6969
<li>
70-
Enables Terragrunt features to reduce the potential changes during a run-all. Terragrunt [queue-strict-include](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-strict-include) and [queue-exclude-external](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-exclude-external) are enabled by default which excludes dependencies from being planned/applied during run-all, and more closely matches the behavior of a single unit change.
70+
Allows users to opt-out of the preflight check that prevents Pipelines from running if the current commit is behind the tip of the deploy branch.
7171

72-
This behavior will likely become the default in a major release of Pipelines but is currently opt-in due to being a breaking change to functionality.
72+
We do not recommend enabling this feature by default as it removes the guarantee that Pipelines will apply the reviewed plan. This feature exists to unblock teams that are facing contention issues keeping branches ahead of their deploy branch - and is 'at your own risk'.
73+
</li>
74+
<li>
75+
**Default Value**: Disabled
76+
</li>
77+
<li>
78+
**How to Enable**: Set to `"true"`
79+
</li>
80+
</ul>
81+
82+
#### `PIPELINES_FEATURE_EXPERIMENT_IGNORE_UNITS_WITHOUT_ENVIRONMENT`
83+
<ul>
84+
<li>
85+
Causes units and files in units to no longer be detected as changes when the flag is enabled and they have no environment.
86+
87+
With Account Factory, new root directories will not be treated as new accounts if they do not have an environment.
88+
89+
When running plans and applies, units with no environment are excluded from the Terragrunt DAG.
90+
91+
**Note**: Adding an environment will not cause units to be detected as an added unit. You will need to also modify the units (e.g., make a whitespace change) to trigger detection.
7392
</li>
7493
<li>
7594
**Default Value**: Disabled
@@ -79,6 +98,26 @@ This behavior will likely become the default in a major release of Pipelines but
7998
</li>
8099
</ul>
81100

101+
#### `PIPELINES_FEATURE_EXPERIMENT_MINIMIZE_BLAST_RADIUS`
102+
<ul>
103+
<li>
104+
Enables Terragrunt features to reduce the potential changes during a run-all. Terragrunt [queue-strict-include](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-strict-include) and [queue-exclude-external](https://terragrunt.gruntwork.io/docs/reference/cli-options/#queue-exclude-external) are enabled by default which excludes dependencies from being planned/applied during run-all, and more closely matches the behavior of a single unit change.
105+
</li>
106+
<li>
107+
**Default Value in Pipelines GitHub v3/GitLab v1**: Disabled
108+
</li>
109+
<li>
110+
**Default Value in Pipelines GitHub v4+/GitLab v2+**: Enabled
111+
</li>
112+
<li>
113+
**How to Enable**: Set to `"true"`
114+
</li>
115+
</ul>
116+
117+
## Deprecated Flags
118+
119+
The following flags are valid in Pipelines GitHub v3/GitLab v1 but are deprecated in Pipelines GitHub v4+/GitLab v2+.
120+
82121
#### `PIPELINES_FEATURE_TERRAGRUNT_INCLUDE_UNITS_READING`
83122
<ul>
84123
<li>
@@ -107,4 +146,4 @@ This is a break-glass feature flag and can be used to disable this functionality
107146
<li>
108147
**How to Disable**: Set to `"false"`
109148
</li>
110-
</ul>
149+
</ul>

0 commit comments

Comments
 (0)