terraform-docs

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!

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 (https://github.com/segmentio/terraform-docs/commit/9422d09f732a132f855cfcf3f4e6d652d3c80a6e, https://github.com/segmentio/terraform-docs/commit/86940f04bd6370993d376a4628ad8f50676c4ebb).

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

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.

• 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

• main: add support for files (@s-urbaniak)
• closes #17 Updated example in README (@nwalke)
• Closes #18 Added a very basic sort to inputs and outputs (@nwalke)
• doc: Account for single whitespace after comment character in header (@paybyphone)
• print/markdown: Better markdown description normalizations (@paybyphone)
• print/markdown: Added line break conversion for outputs (@paybyphone)
• doc: placeholder for list types (@paybyphone)
• doc: Allow top-level comments for variables when description missing (@paybyphone)
• print/markdown: Replace table cell newlines with HTML line breaks (@paybyphone)

• doc: fix map type

Initial release