Generate documentation from Terraform modules in various output formats
e5c8df5 fixed modules section visibility set via commandline (#387) 7b6afa3 include Resource.Mode when sorting to ensure deterministic resource table rendering fb204ca Fix release scripts for chocolatey
docker pull quay.io/terraform-docs/terraform-docs:latest
docker pull quay.io/terraform-docs/terraform-docs:0.11.1
Very special thanks to the contributors.
The most notable changes in this release are:
Note: We've also enabled GoReleaser for the release workflow, and to be able to support all the use-cases we changed the distribution of assets from standalone binary to compressed files (tar.gz and zip). In the upcoming releases we're going to deprecate distribution of standalone binaries, please adjust any scripts accordingly.
24e7cba Update download instruction to use tar.gz aecd044 Use goreleaser for release workflow and tasks 2575a40 added output section for modulecalls 533a82b Add section for Resources 54fc067 Add support for plugin execution aa7224d Add Slack workspace link
4f8952b Do not escape asterisk in markdown or asciidoc 4a98297 Cleanup extra empty lines from 'pretty' output 2353afb Never escape special characters in tfvars json 63750c1 Normalize last empty line of the generated output 4cd6f59 Show correct version when brew installs it
cbc0987 Make Developer Certificate of Origin (DCO) a requirement 37b9faa Move internal/tfconfig out of tree 89d7f6c Move pkg/print to internal/print e3a19ea Move pkg/tfconf to internal/terraform 446b9bc Move pkg/tmpl to internal/template
docker pull quay.io/terraform-docs/terraform-docs:latest
docker pull quay.io/terraform-docs/terraform-docs:0.11.0
Very special thanks to the contributors.
This is a small patch over v0.10.0. It fixes an issue where terraform-docs crashes if provided argument is a file and not a directory.
Note: If you are a user of antonbabenko/pre-commit-terraform, you most probably are affected by this issue and need to upgrade to v0.10.1 otherwise you can continue using v0.10.0 without any issue.
--no-color has been deprecated, use --color=false instead--no-escape has been deprecated, use --escape=false instead--no-header has been deprecated, use --hide header instead--no-inputs has been deprecated, use --hide inputs instead--no-outputs has been deprecated, use --hide outputs instead--no-providers has been deprecated, use --hide providers instead--no-requirements has been deprecated, use --hide requirements instead--no-required has been deprecated, use --required=false instead--no-sensitive has been deprecated, use --sensitive=false instead--no-sort has been deprecated, use --sort=false instead--with-aggregate-type-defaults and --sort-inputs-by-required were marked as deprecated in v0.8.0 and now are removed.Very special thanks to the contributors.
terraform-docs v0.10.0-rc.1 is a pre-release. It is to help gather feedback from the community as well as give users a chance to test terraform-docs in staging environments before v0.10.0 is officially released.
Action Required: This release deprecates handful of flags. Please update your workflow accordingly based on the changelog.
The official changelog will come out with the v0.10.0 release. For now, you can see the interim changelog here.
Note A regression found in this release where if there's no main.tf file available in the module, generating any output formats fails with Error: open main.tf: no such file or directory error.
This has been fixed in v0.9.1 but as a workaround for this release you can explicitly pass --no-header flag to circumvent the issue.
Very special thanks to the contributors.
This release supports Terraform v0.12.x configuration.
With Terraform 0.12 ability to generate output from file has been deprecated in favor of from folder which contains one or more .tf files.
In the JSON format response, list of "Inputs" has been renamed to inputs.
In the JSON format response, list of "Outputs" has been renamed to outputs.
In the JSON format respone, module "Comment" has been renamed to module header.
For simplicity we've decided to deprecated the old --sort-inputs-by-required flag to the simpler and more generic --sort--by-required. The deprecated flags will get removed second release from now.
As of Terraform 0.12, the default value of input variables are shown in full JSON format (if available) and --with-aggregate-type-defaults is not needed anymore. The flag is marked as soft deprecated and will get removed in the second release from now.
With Terraform 0.12 the information about providers being used in the module will be generated by default. This will cause the first generation of documents with the latest release of terraform-docs binary be slightly different than before, now there will be Providers section in Markdown and providers block in JSON. You can ignore this by using new --no-providers flag if you choose to.
Very special thanks for @moatra for the awesome work :heart: