From 8f096d31df46c82df13bfb01b5b725c6ac2c86f7 Mon Sep 17 00:00:00 2001 From: Mikel Kew Date: Sat, 9 Nov 2024 01:46:20 +1000 Subject: [PATCH] Update config doc to fix terragrunt-diff typo (#3515) --- docs/_docs/01_getting-started/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/01_getting-started/configuration.md b/docs/_docs/01_getting-started/configuration.md index cedb793a07..a61551fe09 100644 --- a/docs/_docs/01_getting-started/configuration.md +++ b/docs/_docs/01_getting-started/configuration.md @@ -120,6 +120,6 @@ If you run `terragrunt hclfmt` at the `root`, this will update: - `root/qa/services/service01/terragrunt.hcl` -You can set `--terragrunt-diff` option. `terragrunt hclfmt --terragrunt-check` will output diff in unified format which can be redirected to your favourite diff tool. `diff` utility must be presented in PATH. +You can set `--terragrunt-diff` option. `terragrunt hclfmt --terragrunt-diff` will output the diff in a unified format which can be redirected to your favourite diff tool. `diff` utility must be presented in PATH. Additionally, there’s a flag `--terragrunt-check`. `terragrunt hclfmt --terragrunt-check` will only verify if the files are correctly formatted **without rewriting** them. The command will return exit status 1 if any matching files are improperly formatted, or 0 if all matching .hcl files are correctly formatted.