Skip to content

Releases: hashicorp/terraform-plugin-docs

v0.24.0

13 Oct 20:53

Choose a tag to compare

FEATURES:

  • generate: Support multiple configuration example files in default templates (#508)
  • generate/migrate/validate: Add support for list resources (#528)

v0.23.0

17 Sep 15:53

Choose a tag to compare

FEATURES:

  • generate: Add support for actions (#505)
  • migrate: Add support for actions (#505)
  • validate: Add support for actions (#505)

v0.22.0

01 Jul 16:07

Choose a tag to compare

BREAKING CHANGES:

  • generate: The .ProviderShortName template function now uses the rendered provider name to derive the provider short name. Users that pass in the --rendered-provider-name flag might see a different output for this function (#492)

NOTES:

  • generate: Generated import documentation will now contain more information about which methods are supported by the provider (CLI command, config by ID, config by identity). (#495)

FEATURES:

  • generate: Added support for defining import example file (import-by-string-id.tf) using Terraform configuration and the id attribute (#472)
  • generate: Added support for defining import example file (import-by-identity.tf) using Terraform configuration and the identity attribute (managed resource identity) (#496)

ENHANCEMENTS:

  • validate: Add allowed-guide-subcategories and allowed-resource-subcategories to provide a list of allowed subcategories (#456)
  • validate: Add allowed-guide-subcategories-file and allowed-resource-subcategories-file to provide a file containing a list of allowed subcategories (#456)
  • generate: Default resource and function templates now use .RenderedProviderName instead of .ProviderName (#492)
  • generate: Remove trailing whitespace from default function template when .HasVariadic evaluates to false (#489)

BUG FIXES:

  • validate: Fixed a bug that caused all non-index files to be detected as guides (#456)
  • generate: Remove subcategory field from default provider templates (#446)

v0.21.0

27 Feb 14:38

Choose a tag to compare

FEATURES:

  • generate: Add support for write-only arguments (#434)

v0.20.1

26 Nov 14:38

Choose a tag to compare

BUG FIXES:

  • validate: Fixed a bug that caused false positive validation errors for resource types that have the same name as the provider. (#419)
  • generate: Fixed a bug that caused all generated resource documentation to have the same content when the provider has a resource type with the same name as the provider. (#419)
  • generate: Fixed a bug that would return an error when a static file exists in both templates and docs, which will now be ignored. (#421)

v0.20.0

06 Nov 17:14

Choose a tag to compare

NOTES:

  • all: This Go module has been updated to Go 1.22 per the Go support policy. It is recommended to review the Go 1.22 release notes before upgrading. Any consumers building on earlier Go versions may experience errors. (#400)

FEATURES:

  • generate: Add support for ephemeral resources (#415)
  • migrate: Add support for ephemeral resources (#415)
  • validate: Add support for ephemeral resources (#415)

BUG FIXES:

  • validate: File extension check now runs on index.* files instead of just index.md files. (#413)
  • validate: File extension check now specifies the correct valid extensions in the error message. (#413)
  • validate: Front matter check now runs with the correct options on legacy index files. (#413)

v0.19.4

04 Jun 16:19

Choose a tag to compare

NOTES:

  • validate: The number of files check has been removed to match the latest Terraform Registry ingress logic (#381)

BUG FIXES:

  • generate: Prevented incorrect attribute paths with nested attributes that contain multiple attributes (#380)

v0.19.3

28 May 14:28

Choose a tag to compare

BUG FIXES:

  • validate: Fixed issue with provider name not defaulting to directory (#376)

v0.19.2

29 Apr 19:29

Choose a tag to compare

BUG FIXES:

  • migrate: Ensured idempotency of template files when command is ran multiple times (#364)
  • generate: Prevented automatic id attribute behaviors under blocks (#365)

v0.19.1

22 Apr 15:10

Choose a tag to compare

BUG FIXES:

  • generate: fixed a bug where attribute titles were not being generated for nested object attributes (#357)
  • generate: fixed a bug where the plainmarkdown function did not output plain URLs (#361)