v0.22.0

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

FEATURES:

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

v0.20.1

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

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

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

BUG FIXES:

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

v0.19.2

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

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)

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)