Skip to content

v0.8.0

Compare
Choose a tag to compare
@github-actions github-actions released this 17 Jan 19:49
· 562 commits to master since this release

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 ❤️