Skip to main content

Generate document using terraform-docs

#1859 #1878 v1.8.0

How to use

By default, this feature is disabled.

tfaction-root.yaml:

terraform_docs:
enabled: true

tfaction.yaml:

terraform_docs:
enabled: true

terraform-docs configuration

tfaction searches a configuration file:

  1. .terraform-docs.ya?ml in service directory
  2. .config/.terraform-docs.ya?ml in service directory
  3. .terraform-docs.ya?ml in the repository root directory
  4. .config/.terraform-docs.ya?ml in the repository root directory

https://terraform-docs.io/user-guide/configuration/