v0.19.0

BREAKING CHANGES:

• generate: the plainmarkdown function now removes all markdown elements/formatting to render the output as plain text (#332)
• schemamd: The schemamd package has moved to internal/schemamd and can no longer be imported (#354)
• functionmd: The functionmd package has moved to internal/functionmd and can no longer be imported (#354)

FEATURES:

• validate: Added support for Provider-defined Function documentation to all checks (#341)
• validate: Added InvalidDirectoriesCheck which checks for valid provider documentation folder structure (#341)
• validate: Added MixedDirectoriesCheck which throws an error if both legacy documentation and registry documentation are found (#341)
• validate: Added NumberOfFilesCheck which checks the number of provider documentation files against the registry limit (#341)
• validate: Added FileSizeCheck which checks the provider documentation file size against the registry limit (#341)
• validate: Added FileExtensionCheck which checks for valid provider documentation file extensions (#341)
• validate: Added FrontMatterCheck which checks the YAML frontmatter of provider documentation for missing required fields or invalid fields (#341)
• validate: Added FileMismatchCheck which checks the names/number of provider documentation files against the provider schema (#341)

ENHANCEMENTS:

• migrate: Added --provider-name flag to override the default provider name when any file names that contain provider name prefixes are removed during migration (#349)

BUG FIXES:

• migrate: use relative paths (from provider directory) instead of absolute paths for migrated code templates (#330)
• migrate: fixed a bug where documentation files with provider name prefixes were migrated to templates directory as-is, causing generate to create duplicate templates (#349)
• generate: fixed a bug where incorrect attribute titles were being generated for certain nested schemas (#350)

v0.18.0

FEATURES:

• generate: Add support for Provider-defined Function documentation (#328)
• migrate: Add support for Provider-defined Function documentation (#328)

ENHANCEMENTS:

• validate: Add functions to list of allowed template and rendered website subdirectories (#328)

v0.17.0

BREAKING CHANGES:

• generate: templates using printf with either codefile or tffile to render code examples in markdown will need to switch to using those functions directly.
  For example, switch the following template code:
  {{printf "{{codefile \"shell\" %q}}" .ImportFile}}
  to
  {{codefile "shell" .ImportFile}} (#300)

FEATURES:

• migrate: Added new migrate subcommand that migrates existing provider docs using the rendered website source directories (website/docs/ or /docs/) to a terraform-plugin-docs-supported templates directory. (#314)

ENHANCEMENTS:

• generate: Add provider-schema flag to pass in a file path to a provider schema JSON file, allowing the command to skip building the provider and calling Terraform CLI (#299)

BUG FIXES:

• generate: fix no such file or directory error when running generate with no existing rendered website directory. (#296)
• generate: fix incorrect rendering of example and import files for providers with no docs templates or with generic fallback templates. (#300)

v0.16.0

ENHANCEMENTS:

• generate: Prevent files and subdirectories in the rendered website directory that are not directly managed by tfplugindocs from being deleted during generation (#267)
• validate: Add cdktf to list of allowed rendered website subdirectories (#267)

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