terraform-docs/terraform-docs v0.10.0

on GitHub

Changelog

BREAKING CHANGE

• Following flags have been deprecated and will be removed in the following releases:
  • Flag --no-color has been deprecated, use --color=false instead
  • Flag --no-escape has been deprecated, use --escape=false instead
  • Flag --no-header has been deprecated, use --hide header instead
  • Flag --no-inputs has been deprecated, use --hide inputs instead
  • Flag --no-outputs has been deprecated, use --hide outputs instead
  • Flag --no-providers has been deprecated, use --hide providers instead
  • Flag --no-requirements has been deprecated, use --hide requirements instead
  • Flag --no-required has been deprecated, use --required=false instead
  • Flag --no-sensitive has been deprecated, use --sensitive=false instead
  • Flag --no-sort has been deprecated, use --sort=false instead
• Flags --with-aggregate-type-defaults and --sort-inputs-by-required were marked as deprecated in v0.8.0 and now are removed.

Features

• Add support for .terraform-docs.yml config file (#272)
• Build and push docker image (#289)
• Add new flags: --show, --show-all, --hide-all (#267)
• Add support for TOML renderer (#197)
• Add new flag to sort inputs by type (#246)
• Add support for AsciiDoc renderer (#241)

Bug Fixes

• Normalize variables with CRLF line ending in heredoc (#307)
• Render special chars in variables' default value properly (#284)

Refactoring

• Refactor cli implemention and configuration (#266)
• Deprecate multiple flags in favor of new ones (#265)
• Remove deprecated flags (#229)
• Add factory function to return format types (#243)
• Reorganize markdown format tests (#244)

Documentation

• Overall improvements to documentation (#293)
• Add detail about module header usage guide (#282)

Contributors

Very special thanks to the contributors.

• @achaussier
• @dependabot[bot]
• @dependabot-preview[bot]
• @swails
• @jlosito
• @plouufff
• @khos2ow
• @rdelcampog
• @ryanking
• @tomoasleep