Making it so that usage of a root terragrunt.hcl throws a warning for users, and gives them guidance to move to a differently named root configuration file.
Lots of docs updates necessary.
There are also considerations for Catalog/Scaffold that have to be taken into account.
[x] Run the relevant tests successfully, including pre-commit checks.
[x] Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
[x] Include release notes. If this PR is backward incompatible, include a migration guide.
Release Notes (draft)
Updated strict package.
Updated config package.
Migration Guide
Current idiomatic usage of Terragrunt involves using a root configuration file named terragrunt.hcl.
This causes a lot of confusion for users, and potential errors. With this change, the new recommendation of naming it anything else will be enforced via the strict package.
It will likely take a very long time before this functionality can be removed, so we should start updating our documentation to reflect this change and throw warnings that users are using less reliable configurations.
Description
Making it so that usage of a root
terragrunt.hclthrows a warning for users, and gives them guidance to move to a differently named root configuration file.Lots of docs updates necessary.
There are also considerations for Catalog/Scaffold that have to be taken into account.
TODOs
Read the Gruntwork contribution guidelines.
Release Notes (draft)
Updated
strictpackage. Updatedconfigpackage.Migration Guide
Current idiomatic usage of Terragrunt involves using a root configuration file named
terragrunt.hcl.This causes a lot of confusion for users, and potential errors. With this change, the new recommendation of naming it anything else will be enforced via the
strictpackage.It will likely take a very long time before this functionality can be removed, so we should start updating our documentation to reflect this change and throw warnings that users are using less reliable configurations.