v0.8.0

Changelog

This release supports Terraform v0.12.x configuration.

BREAKING CHANGE

• 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.

Features

• Add '--no-escape' flag to 'json' command (#147)
• Add flags to not show different sections (#144)
• Add '--no-color' flag to 'pretty' command (#143)
• Show 'providers' information (#140)
• Bump golang to latest v1.13 (#133)
• Support Terraform 0.12.x configuration (#113)

Bug Fixes

• Do not escape any characters of a URL (#170)
• Add double space at the end of multi-lines paragraph (#169)
• Show empty JSON properties, as 'null' for all types (#166)
• Show all JSON properties, empty or null (#160)
• Do not escape strings inside code blocks (#155)
• Read leading module header from main.tf (#154)
• Read leading comment lines if description is not provided (#151)
• Reimplement '--no-sort' to be compatible with Terraform 0.12 configuration (#141)

Enhancements

• Rename flag to '--sort-by-required' (#150)
• Mark '--with-aggregate-type-defaults' as deprecated (#148)
• Bump homebrew formula version on release (#135)
• Enable new go linters and fix the existing issues (#132)

Refactoring

• Move doc.Doc to tfconf.Module (#136)

Documentation

• Initial commit of usage documentation (#162)
• Deprecate accepting files as commands param (#163)
• Update Module internal documentaion

Contributors

Very special thanks for @moatra for the awesome work ❤️

• @chenrui333
• @khos2ow
• @moatra

v0.8.0-rc.3

terraform-docs v0.8.0-rc.3 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.8.0 is officially released.

This release supports Terraform v0.12.x configuration.

The official changelog will come out with the v0.8.0 release. For now, you can see the interim changelog here.

v0.8.0-rc.2

terraform-docs v0.8.0-rc.2 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.8.0 is officially released.

This release supports Terraform v0.12.x configuration.

The official changelog will come out with the v0.8.0 release. For now, you can see the interim changelog here.

Notes:

• There's currently one outstanding issue for rendering markdown table format (#138 (comment)), any feedback or help on this issue is greatly appreciated.

v0.8.0-rc.1

terraform-docs v0.8.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.8.0 is officially released.

This release supports Terraform v0.12.x configuration.

The official changelog will come out with the v0.8.0 release. For now, you can see the interim changelog here.

Notes:

• 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.
• There's currently a known issue for rendering markdown table format (#138), please give us feedback if you happen to have any issues with that too.

v0.7.0

Changelog

Features

• Code blocks support for all formats. Single line break support (#123)
• Add --no-escape flag for Markdown printer (#117)
• Use Cobra CLI instead of docopt (#116)
• Escape pipe character when generating Markdown (#114)
• Replace dep with Go Modules (#100)
• Replace gometalinter with golangci-lint. (#103)

Bug Fixes

• target deps was missing (required by all) (#126)
• Add support for controlling the indentation of Markdown headers (#120)
• Fix typo in options documentation (#98)

Refactoring

• Use Github Actions instead of Circle CI (#124)
• Refactor Settings for better performance (#119)
• Enhance release scripts
• Generate release note based on the current tag changelog
• Enhance Makefile and add editorconfig (#115)
• Add Changelog generation via git-chglog. (#104)

Documentation

• Update Installation and Code Completion in README
• Add 'enhancement' section to pull request template (#101)

Contributors

• @HighwayofLife
• @hmalphettes
• @khos2ow
• @metmajer
• @yutachaos

v0.6.0

This release adds the following improvements:

Features

• Add subcommand terraform-docs md document to generate Markdown representing inputs and outputs in a document format (#81)

Bugfixes

• Fix 'authors' target in Makefile to get an author's email address, not the committer's (#90)

Miscellaneous

• Unified presentation of default values and descriptions across printer types (#96, #97)

Special thanks to @khos2ow for the hard work!

v0.5.0

This release adds the following improvements:

Features

• Add option terraform-docs --sort-inputs-by-required to sort inputs by required, then by name.

Bugfixes

• Fix escaping of underscores for variable names in Markdown (#63).

Miscellaneous

• Add Homebrew formula (9422d09, 86940f0).

v0.4.5

This release adds the following improvements:

Bugfixes

• Fix loading of comments from main.tf on Windows (#65).
• Fix needless newlines in Markdown output to resolve markdownlint warnings (#66).
• Fix support for unquoted names for Terraform inputs and outputs (#70).
• Fix Windows binary to be named terraform-docs.exe (#72).
• Fix directory structure created by make build to create bin/$OS-$ARCH/terraform-docs (#74).

v0.4.0

This release adds the following improvements:

Features

• Add option terraform-docs --version to documentation.
• Add option terraform-docs --no-sort to omit sorting of inputs and outputs (#61).
• Add option terraform-docs --with-aggregate-type-defaults to render default value of types list and map (#53).

GitHub

• Add Contribution Guidelines in CONTRIBUTING.md.
• Add Issue and Pull Request templates in .github.

Testing

• Add static checks for errors and warnings using gometalinter.
• Refactor code to improve testability and facilitate future community contributions (#59, #60).
• Add tests to prevent against future regressions. Increase test coverage to > 90%.
• Add CircleCI configuration (#56, #58).

Miscellaneous

• Add complete Makefile.
• Add dependency management using deps.
• Add automated generation of AUTHORS using git log.

v0.3.0

• fixed name handling to handle unquoted hcl variable names.
• fix typo
• Prefer leading comments over description for outputs to maintain compatability.
• *: add --no-required option
• doc: snakecase -> camelcase
• Add support for printing the variable 'type' in Markdown. Currently only markdown supported, but trivial to add to other outputs.
• Add support for reading description tag from output resources. Fixes #24
• Add note about installing with Homebrew
• Strip # prefix from comments
• add proper license
• auto version