Skip to content

Releases: hashicorp/terraform-plugin-docs

v0.13.0

08 Jul 10:39
Compare
Choose a tag to compare

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

29 Jun 15:45
Compare
Choose a tag to compare

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

28 Jun 17:27
Compare
Choose a tag to compare

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

14 Jun 13:45
70c0afc
Compare
Choose a tag to compare

BUG FIXES:

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

v0.10.0

13 Jun 11:23
Compare
Choose a tag to compare

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

01 Jun 10:42
Compare
Choose a tag to compare

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

10 May 18:48
56980e0
Compare
Choose a tag to compare

BUG FIXES:

v0.8.0

03 May 17:13
Compare
Choose a tag to compare

ENHANCEMENTS:

  • template functions: Added split to help separating a string into substrings (#70).

BUG FIXES:

  • cmd/tflugindocs: Support for schemas containing empty nested attributes or empty nested blocks (#99, #134).
  • schemamd: Attribute ID is considered "Read Only", unless there's a description defined, in which case it's handled like any other attribute in the schema (#46, #134).

v0.7.0

15 Mar 17:42
1bf068a
Compare
Choose a tag to compare

ENHANCEMENTS:

  • cmd/tfplugindocs: Use existing Terraform CLI binary if available on PATH, otherwise download latest Terraform CLI binary (#124)
  • cmd/tfplugindocs: Added tf-version flag for specifying Terraform CLI binary version to download, superseding the PATH lookup (#124)

BUG FIXES:

  • cmd/tfplugindocs: Swapped .Type and .Name resource and data source template fields so they correctly align (#44)
  • schemamd: Switched attribute name rendering from bold text to code blocks so the Terraform Registry treats them as anchor links (#59)

v0.6.0

14 Mar 13:38
Compare
Choose a tag to compare

NOTES:

  • The github.com/hashicorp/terraform-exec dependency has been updated to match terraform-plugin-sdk, which replaced the removed tfinstall package with github.com/hashicorp/hc-install. This will resolve Go build errors for projects that import both terraform-plugin-docs and terraform-plugin-sdk.