@blakegong any update on the fix?

Any update on this or a workaround to skip root README from being updated ?

Hi! Any updates on this?

Could one of the project maintainers please review @blakegong 's pull request?

I'm working around this issue for now by using the hide-empty setting. It works as long as you don't have Terraform files in the root, and you're ok with hiding empty sections.

output:
  file: README.md
  mode: inject
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->
settings:
  hide-empty: true

@metmajer , @khos2ow can any of you guys press the merge button? Looks like a minor thing and bumped into this issue too. Just pinging since its open since 2022, might have dropped of the radar ;)

I'm working around this issue for now by using the hide-empty setting. It works as long as you don't have Terraform files in the root, and you're ok with hiding empty sections.

output:
  file: README.md
  mode: inject
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->
settings:
  hide-empty: true

For me, it's not work:(
It still generates an empty .md file only with a comment block.
Something like this

<!-- BEGIN_TF_DOCS -->
<!-- END_TF_DOCS -->

Also, I've tried to add empty .md files to .gitignore but it's still generating files:(

Example:

.gitignore file
# Ignore empty TF-DOC.md files
TF-DOC.tf
./modules/TF-DOC.tf

As the PR does not seem to get merged, you can meanwhile use a workaround:

terraform-docs markdown --output-mode replace --output-file README.md --recursive --recursive-path ../ ./modules/name-of-module

The following args work for me:
args: ["markdown", "table", "--output-mode", "replace", "--output-file", "README.md", "--recursive", "./modules", "--recursive-path", "."]

I had a problem where terraform-docs were modifying the root README of my repository. The above args fixed the issue for me.

Just as an FYI, my repo structure:

• ...
• modules/
• README.md

now terraform-docs only updates readme files in modules/ and all modules/, but not the root of the repository.