How to run terraform-docs for code inside a sub folder

[maulik-vimond]

I am trying to run terraform-docs hook for the terraform configuration inside a subfolder called "terraform". When I run pre-commit run terraform_docs -a no documentation is generated. The output says "Passed" for terraform docs.

But if I run terraform-docs manually it works using terraform-docs md ./terraform

Here is my config file:

repos:
  - repo: https://github.com/talos-systems/conform
    rev: v0.1.0-alpha.20
    hooks:
      - id: conform
  - repo: git://github.com/antonbabenko/pre-commit-terraform
    rev: v1.47.0
    hooks:
    - id: terraform_fmt
    - id: terraform_docs
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
    - id: end-of-file-fixer

I am using,
pre-commit=2.10.1
terraform-docs=0.11.2
pre-commit-terraform=1.47.0

[maulik-vimond]

I found the problem,

pre-commit-terraform/terraform_docs.sh

Line 128 in d303bff

terraform-docs md $args ./ > "$tmp_file"

And I have found the workaround using terraform_docs_replace and specify a destination file.

EDIT: I have updated the code to point to the correct version

[sajidk1]

I found the problem, https://github.com/antonbabenko/pre-commit-terraform/blob/master/terraform_docs.sh#L128

And I have found the workaround using terraform_docs_replace and specify a destination file.

Can you share the workaround please? We also have terraform in sub folders

[maulik-vimond]

@sajid-khan-js We simply switched to using the following that will create TFDOC.md file for each module (including nested modules).

- id: terraform_docs_replace
      args: ['--sort-by-required', '--dest=TFDOC.md']

[sajidk1]

Thanks @maulik-vimond.

terraform_docs_replace does not fit our needs since we use the inline hooks (we have user generated docs also in the readme).

Strangely, switching to terraform_docs_without_aggregate_type_defaults works! I have no idea why, it's the exact same script/hook: #150

I've only tested locally, so not sure if it's my setup. Once I get this added to our CI environment I can confirm the odd result.

[maulik-vimond]

@sajid-khan-js yes of course. We came to a compromise of having a separate doc for terraform.

I think terraform_docs_without_aggregate_type_defaults works because of the condition (using awk?) and hitting this line:

pre-commit-terraform/terraform_docs.sh

Line 139 in fa3859e

terraform-docs md $args "$tmp_file_docs_tf" > "$tmp_file"

[brettcurtis]

Is this still not working? I can't figure out how to get a single subfolder to work. Ideally, I want two "global" & "regional" -

.
├── README.md
├── global
│   ├── backend.tf -> ../shared/backend.tf
│   ├── main.tf
│   ├── outputs.tf
│   ├── plan.out
│   ├── tfvars
│   │   ├── acc.tfvars
│   │   ├── exp.tfvars
│   │   ├── prod.tfvars
│   │   ├── sb.tfvars
│   │   └── uat.tfvars
│   └── variables.tf
├── plan.out
├── regional
│   ├── backend.tf -> ../shared/backend.tf
│   ├── main.tf
│   ├── outputs.tf
│   ├── plan.out
│   ├── tfvars
│   │   ├── europe-west1-acc.tfvars
│   │   ├── europe-west1-exp.tfvars
│   │   ├── europe-west1-prod.tfvars
│   │   ├── europe-west1-sb.tfvars
│   │   ├── europe-west1-uat.tfvars
│   │   ├── europe-west4-exp.tfvars
│   │   ├── europe-west4-prod.tfvars
│   │   └── europe-west4-sb.tfvars
│   └── variables.tf
└── shared
    └── backend.tf

pre-commit 2.13.0
terraform-docs version v0.14.1 linux/amd64

[ilyagorban-codefresh]

I still have the same issue (empty markdown file in subfolders) with:
pre-commit 2.14.0
terraform-docs version v0.15.0 darwin/amd64

The workaround below does not work for me

@sajid-khan-js We simply switched to using the following that will create TFDOC.md file for each module (including nested modules).

- id: terraform_docs_replace
      args: ['--sort-by-required', '--dest=TFDOC.md']

Workaround that worked for me (although it is not sorts):

pre-commit autoupdate
pre-commit uninstall
pre-commit install

and removal of '--sort-by-required'