v0.15.0

BREAKING CHANGES:

• generate: The legacy-sidebar flag has been removed without replacement. It implemented no logic and is not necessary with Terraform Registry based documentation (#258)

NOTES:

• This Go module has been updated to Go 1.19 per the Go support policy. Any consumers building on earlier Go versions may experience errors. (#231)

ENHANCEMENTS:

• generate: Added provider-dir flag, which enables the command to be run from any directory (#259)

v0.14.1

BUG FIXES:

• dependencies: github.com/hashicorp/terraform-exec dependency upgraded to v0.18.1 to avoid causing acceptance test failures when terraform-plugin-sdk or terraform-plugin-testing are in use (#226)

v0.14.0

NOTES:

• This Go module has been updated to Go 1.18 per the Go support policy. Any consumers building on earlier Go versions may experience errors (#199)

v0.13.0

ENHANCEMENTS:

• schemamd: Nested attributes are now correctly grouped in "optional", "required" and "read-only" (#163).

BUG FIXES:

• template functions: title now capitalizes each word in the input string, instead of upper-casing them (#165).

v0.12.0

BUG FIXES:

• template data: A regression was introduced in #155 making template data field HasExample and HasImport always true (#162).

NEW FEATURES:

• template functions: Added lower, upper and title (#162).

ENHANCEMENTS:

• Added documentation for all the template functions and template data fields (#162).

v0.11.0

NEW FEATURES:

• cmd/tfplugindocs: Additional CLI argument ignore-deprecated allows to skip deprecated resources and data-sources when generating docs (#154).

BUG FIXES:

• cmd/tfplugindocs: Pass through filepaths for examples and import to allow use of HasExample and HasImport template helpers in custom templates (#155).
• cmd/tfplugindocs: Fixed issue with the generation of title and reference links, when nested attributes go too deep (#56).

v0.10.1

BUG FIXES:

• cmd/tfplugindocs: Do not error when schema not found, issue log warning (#151).

v0.10.0

BUG FIXES:

• cmd/tfplugindocs: Allow single word resources to use templates (#147).
• cmd/tfplugindocs: Pass in correct provider name for data-source and resource schema lookup when overidden with rendered-provider-name flag (#148).

ENHANCEMENTS:

• cmd/tfplugindocs: Expose RenderedProviderName to templates (#149).

v0.9.0

NEW FEATURES:

• cmd/tflugindocs: Additional CLI arguments provider-name, rendered-provider-name, rendered-website-dir, examples-dir, website-temp-dir, and website-source-dir. These allow to further customise generated doc (#95).

ENHANCEMENTS:

• cmd/tflugindocs: Implemented usage output (i.e. --help) for generate and validate commands (#95).

v0.8.1

BUG FIXES:

• cmd/tfplugindocs: Updated version of hc-install in response to change in HashiCorp Release API sending back a different Content-Type header. This was causing failures when the tool attempted to install Terraform. (#135)