Skip to content

Latest commit

 

History

History
413 lines (332 loc) · 22.5 KB

CHANGELOG.md

File metadata and controls

413 lines (332 loc) · 22.5 KB

CHANGELOG

Unreleased

v0.10.1 - 2020-09-28

Bug Fixes

  • Prevent segfault error if input arg is a file (#327)

v0.10.0 - 2020-09-21

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

v0.9.1 - 2020-04-02

Bug Fixes

  • Don't crash when reading header if 'main.tf' not found (#235)
  • Make sure requirements section is sorted (#233)

v0.9.0 - 2020-03-31

Features

  • Add support for tfvars hcl and json commands (#226)
  • Allow hiding the "Sensitive" column in markdown (#223)
  • Add section for module requirements (#222)
  • Add support for fetching the module header from any file (#217)
  • Add support for XML renderer (#198)
  • Show sensitivity of the output value in rendered result (#207)
  • Extract and render output values from Terraform (#191)
  • Render formatted results with go templates (#177)
  • Add support for YAML renderer (#189)

Bug Fixes

  • Mark variables not required if default set to null (#221)
  • --no-header should not attempt reading main.tf file (#224)
  • Fix type conversion for numbers (#204)

Enhancements

  • Add extensive tests coverage for all the packages (#208)

Refactoring

  • Add Default value types for better marshalling (#196)
  • Introduce Format interface and expose to public pkg (#195)
  • Add tfconf.Options to load Module with (#193)

Documentation

  • Enhance automatic document generation (#227)
  • Add installation guide for Windows users (#218)
  • Put reference to usage, cli, etc. in user guide (#216)
  • Example git hook to keep module docs up to date (#214)
  • Auto generate formats document from examples (#192)

v0.8.2 - 2020-02-03

Bug Fixes

  • Do not escape markdown table inside module header (#186)
  • Add double space only at the end of paragraph lines (#185)
  • Preserve asterisk list in header and fix escaping (#179)
  • Add newline between code block and trailing lines (#184)

v0.8.1 - 2020-01-21

Bug Fixes

  • Show native map and list as default value in JSON (#174)

v0.8.0 - 2020-01-17

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

v0.7.0 - 2019-12-12

  • Update Changelog
  • Release version v0.7.0
  • Use Github Actions instead of Circle CI (#124)
  • Enhance release scripts
  • Generate release note based on the current tag changelog
  • Update Installation and Code Completion in README
  • Code blocks support for all formats. Single line break support (#123)
  • Update Changelog
  • target deps was missing (required by all) (#126)
  • Enhance Makefile and add editorconfig (#115)
  • Add support for controlling the indentation of Markdown headers (#120)
  • Refactor Settings for better performance (#119)
  • Add --no-escape flag for Markdown printer (#117)
  • Update Changelog.
  • Use Cobra CLI instead of docopt (#116)
  • Update Changelog.
  • Escape pipe character when generating Markdown (#114)
  • Add appropriate Changelog header.
  • Complete development requirements documentation.
  • Configure git-chglog to not show git merge commit messages.
  • Add Changelog generation via git-chglog. (#104)
  • Remove occurrence of gometalinter from CircleCI config.
  • Replace dep with Go Modules (#100)
  • Replace gometalinter with golangci-lint. (#103)
  • Add 'enhancement' section to pull request template (#101)
  • Fix typo in options documentation (#98)
  • Bump Homebrew formula to 0.6.0.

v0.6.0 - 2018-12-13

  • Bump version to 0.6.0.
  • Unify default values of inputs (#97)
  • Unify description text of inputs and outputs (#96)
  • Capitalize headings in documentation.
  • Fix Markdown lint errors and enhancement in README (#94)
  • Update project documentation.
  • Move Terraform test configuration to folder 'examples'.
  • Capitalize the word 'markdown' in documentation.
  • Purge History.md file.
  • Add support for rendering Markdown documents (#81)
  • Migrate from github.com/tj/docopt to github.com/docopt/docopt-go (#91)
  • Fix authors target in Makefile to get 'Author''s email not 'Committer' (#90)
  • Add requirement to discuss suitability of a new feature in an issue before submitting a pull request.

v0.5.0 - 2018-10-24

  • Bump version to 0.5.0.
  • Add support to print Markdown files with underscored variable names escaped (#48) (#63)
  • Add CircleCI badge.
  • Fix homebrew formula. (#75)
  • Add sort by "required" and then name (#43)
  • Add Homebrew formula. (#68)

v0.4.5 - 2018-10-07

  • Bump version to 0.4.5.
  • Allow unquoted item names. Fixes #64 (#70)
  • Change build dir structure (#74)
  • Update makefile to fix Windows build filename (#72)
  • Remove extra newlines between comments and inputs/outputs to fix MarkDownLint warnings (#66)
  • Fix loading of comments from main.tf on Windows (#65)

v0.4.0 - 2018-09-23

  • Bump version to 0.4.0.
  • Add option --with-aggregate-type-defaults to enable printing of default values for types 'list' and 'map'. (#53)
  • Add option --no-sort to omit sorted rendering of inputs and outputs. (#61)
  • Refactor package 'doc' for better modularity. (#60)
  • Refactor package 'print' for better modularity. (#59)
  • Complete CircleCI config. Add vendor directory. (#58)
  • Update AUTHORS.
  • Add issue and pull request templates.
  • Add contributing guidelines.
  • Fix indentation.
  • Update documentation and license to reflect the terraform-docs authors.
  • Update documentation.
  • Move packages 'doc' and 'print' to internal/pkg.
  • Add automated tests for package 'print'.
  • Add automated tests for package 'doc'.
  • Refactor code in main and prepare for tests.
  • Add documentation of --version option.
  • Add make target to run Go tests.
  • Add make target to create and push a Git tag.
  • Add make target to check Go sources for errors and warnings. Remove unused code.
  • Add make target to create AUTHORS file from git logs.
  • Add make target to clean the workspace.
  • Add dependency management using go deps.
  • Add Makefile header and build target.
  • Add base CI config (#56)
  • Add Maintenance section to Readme (#55)
  • Update Readme.md
  • Merge pull request #44 from coveo/description-before-comments
  • If there is a description on an output, it should be considered before the preceding comment

v0.3.0 - 2017-10-22

  • Release v0.3.0
  • auto version
  • Merge pull request #39 from BWITS/#38
  • bugfix/#38
  • Merge pull request #36 from nwalke/fix_version_string
  • closes #35 Updated version string

v0.2.0 - 2017-08-15

  • Release v0.2.0

v0.1.1 - 2017-08-15

  • Release v0.1.1
  • Merge pull request #34 from COzero/master
  • Merge pull request #1 from COzero/unquoted_names
  • fixed name handling to handle unquoted hcl variable names.
  • Merge pull request #31 from BWITS/typo
  • fix typo
  • Merge pull request #28 from s-urbaniak/no-required
  • Merge pull request #25 from fatmcgav/support_output_description
  • Prefer leading comments over description for outputs to maintain compatability.
  • *: add --no-required option
  • snakecase -> camelcase
  • Merge pull request #27 from fatmcgav/support_printing_type
  • 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
  • Merge pull request #23 from jacobwgillespie/patch-1
  • Add note about installing with Homebrew
  • Merge pull request #22 from jacobwgillespie/patch-1
  • Strip # prefix from comments
  • add proper license

v0.1.0 - 2017-03-21

  • Release v0.1.0
  • Merge pull request #21 from s-urbaniak/files
  • add support for files
  • Merge pull request #20 from nwalke/update_readme_example
  • closes #17 Updated example in README
  • Merge pull request #19 from nwalke/add_sorting
  • Closes #18 Added a very basic sort to inputs and outputs
  • Merge pull request #16 from paybyphone/master
  • Account for single whitespace after comment character in header
  • print/markdown: Better markdown description normalizations
  • print/markdown: Added line break conversion for outputs
  • placeholder for list types
  • Allow top-level comments for variables when description missing
  • print/markdown: Replace table cell newlines with HTML line breaks
  • Merge pull request #13 from jbussdieker/jbb-fix-heredoc-description
  • Trim whitespace on markdown description too
  • Fix HEREDOC descriptions

v0.0.2 - 2016-06-29

  • Release v0.0.2
  • Merge pull request #11 from segmentio/fix-md
  • wrap default values
  • Merge pull request #10 from segmentio/fix-map-type
  • fix map type
  • add more install notes
  • add dist

v0.0.1 - 2016-06-15

  • Merge pull request #5 from segmentio/fix-comment
  • use /** comment for module commnet
  • actually print head comment
  • img
  • Merge pull request #4 from segmentio/layout
  • fix view
  • docs
  • ignore comments with /** prefix
  • add head comment
  • cleanup
  • cleanup
  • ocd
  • ocd
  • update doc
  • add installation
  • cleanup
  • add usage
  • better md output
  • add markdown output
  • use comments as description
  • ocd
  • clean
  • working
  • Initial commit