Skip to content

Commit c2433d0

Browse files
committed
add heads up about terraform docs
1 parent 0be3b1b commit c2433d0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ This repository uses [Devbox](https://www.jetify.com/devbox) to manage the Devel
2424

2525
This project follows an Account-Region based deployment, i.e. an environment is treated as the combination of AWS Accont and AWS Region (e.g. us-east-1 resources in account 111111111111 is treated as a single environment).
2626

27+
28+
PS: If you DO NOT intend to use terraform modules, you should set `recursive.enabled` value on file `.terraform-docs.yml` to `false`, otherwise the following error will be seen:
29+
30+
```
31+
::debug working_dir=.
32+
::debug config_file=.terraform-docs.yml
33+
::debug output_mode=inject
34+
::debug output_file=README.md
35+
::debug terraform-docs markdown table --config .terraform-docs.yml --output-mode inject --output-file README.md --output-template <!-- BEGIN_TF_DOCS -->
36+
{{ .Content }}
37+
<!-- END_TF_DOCS --> .
38+
Error: stat modules: no such file or directory
39+
```
40+
2741
## How does this CI/CD work?
2842
There is a custom GitHub Actions (`./github/actions/terraform/action.yaml` file) action that is used to run terraform plan and apply commands in a given environment, please check the `./github/workflows/main.yaml` file to understand how this is being used. A `ci` Job was also created to validate formating, linting and security issues.
2943

0 commit comments

Comments
 (0)