https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/ Recent content in How-toes on Hugo -- gohugo.io en-US https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/cli-flag-false-value/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/cli-flag-false-value/ Boolean flags can only take arguments via --flag=[true|false] or for short names (if available) -f=[true|false]. You cannot use --flag [true|false] nor can you use the shorthand -f [true|false] as it will result in the following error: Error: accepts 1 arg(s), received 2 Example: # disable reading .terraform.lock.hcl $ terraform-docs markdown --lockfile=false /path/to/module https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/configuration-file/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/configuration-file/ Since v0.10.0 Configuration can be loaded with -c, --config string. Take a look at configuration page for all the details. $ pwd /path/to/parent/folder $ tree . ├── module-a │ └── main.tf ├── module-b │ └── main.tf ├── ... └── .terraform-docs.yml # executing from parent $ terraform-docs -c .terraform-docs.yml module-a/ # executing from child $ cd module-a/ $ terraform-docs -c ../.terraform-docs.yml . # or an absolute path $ terraform-docs -c /path/to/parent/folder/.terraform-docs.yml . https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/visibility-of-sections/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/visibility-of-sections/ Since v0.10.0 Output generated by terraform-docs consists of different sections which are visible by default. The visibility of these can be controlled by one of the following options: --show <name> --hide <name> --show-all (deprecated in v0.13.0, removed in v0.15.0) --hide-all (deprecated in v0.13.0, removed in v0.15.0) As of v0.13.0 flags --show-all and --hide-all are deprecated in favor of explicit use of --show and --hide. In other words when --show <section> is used, only <section> will be shown. https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/ignore-resources/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/ignore-resources/ Since v0.18.0 Any type of resources can be ignored from the generated output by prepending them with a comment terraform-docs-ignore. Supported type of Terraform resources to get ignored are: resource data module variable output If a resource or data is ignored, their corresponding discovered provider will also get ignored from “Providers” section. Take the following example: ################################################################## # All of the following will be ignored from the generated output # ################################################################## # terraform-docs-ignore resource "foo_resource" "foo" {}# This resource is going to get ignored from generated # output by using the following known comment. https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/insert-output-to-file/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/insert-output-to-file/ Since v0.12.0 Generated output can be inserted directly into the file. There are two modes of insertion: inject (default) or replace. Take a look at output configuration for all the details. terraform-docs markdown table --output-file README.md --output-mode inject /path/to/module --output-file can be relative to module path or an absolute path in filesystem. $ pwd /path/to/module $ tree . . ├── docs │ └── README.md ├── ... └── main. https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/include-examples/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/include-examples/ Since v0.14.0 Example can be automatically included into README by using content in configuration file. For example: $ tree . ├── examples │ ├── example-1 │ │ ├── main.tf │ └── example-2 │ └── main.tf ├── ... ├── main.tf ├── variables.tf ├── ... └── .terraform-docs.yml and # .terraform-docs.ymlcontent:|-{{ .Header }} ## Example ```hcl {{ include "examples/example-1/main.tf" }} ``` {{ .Inputs }} {{ .Outputs }} https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/recursive-submodules/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/recursive-submodules/ Since v0.15.0 Considering the file structure below of main module and its submodules, it is possible to generate documentation for the main and all its submodules in one execution, with --recursive flag. Generating documentation recursively is allowed only with --output-file set. Path to find submodules can be configured with --recursive-path (defaults to modules). The main module document is generated by default, which can be configured with --recursive-include-main. https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/generate-terraform-tfvars/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/generate-terraform-tfvars/ Since v0.9.0 You can generate terraform.tfvars in both hcl and json format by executing the following, respectively: terraform-docs tfvars hcl /path/to/module terraform-docs tfvars json /path/to/module Required input variables will be "" (empty) in HCL and null in JSON format. https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/github-action/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/github-action/ To use terraform-docs GitHub Action, configure a YAML workflow file (e.g. .github/workflows/documentation.yml) with the following: name:Generate terraform docson:- pull_requestjobs:docs:runs-on:ubuntu-lateststeps:- uses:actions/checkout@v3with:ref:${{ github.event.pull_request.head.ref }}- name:Render terraform docs and push changes back to PRuses:terraform-docs/gh-actions@mainwith:working-dir:.output-file:README.mdoutput-method:injectgit-push:"true"Read more about terraform-docs GitHub Action and its configuration and examples. https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/pre-commit-hooks/ Mon, 01 Jan 0001 00:00:00 +0000 https://deploy-preview-66--terraform-docs-live.netlify.app/how-to/pre-commit-hooks/ Since v0.12.0 With pre-commit, you can ensure your Terraform module documentation is kept up-to-date each time you make a commit. simply create or update a .pre-commit-config.yaml in the root of your Git repo with at least the following content: repos:- repo:https://github.com/terraform-docs/terraform-docsrev:"<VERSION, TAG, OR SHA TO USE>"# e.g. "v0.11.2"hooks:- id:terraform-docs-goargs:["ARGS","TO PASS","INCLUDING PATH"]# e.g. ["--output-file", "README.md", "./mymodule/path"] You can also include more than one entry under hooks: to update multiple docs.