Releases: hashicorp/terraform-plugin-docs
Releases · hashicorp/terraform-plugin-docs
v0.19.4
v0.19.3
v0.19.2
v0.19.1
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 tointernal/schemamd
and can no longer be imported (#354) - functionmd: The
functionmd
package has moved tointernal/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
v0.17.0
BREAKING CHANGES:
- generate: templates using
printf
with eithercodefile
ortffile
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 aterraform-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:
v0.16.0
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)