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)
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)
0.18.0 (January 24, 2024)
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)
0.17.0 (January 17, 2024)
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)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps github.com/hashicorp/terraform-plugin-docs from 0.14.1 to 0.19.0.
Release notes
Sourced from github.com/hashicorp/terraform-plugin-docs's releases.
... (truncated)
Changelog
Sourced from github.com/hashicorp/terraform-plugin-docs's changelog.
... (truncated)
Commits
45dd248
Update changelog1f28b7c
Moveschemamd
andfunctionmd
packages tointernal
(#354)ab779d3
calc path in title next to anchorID (#350)e7e94b3
Bump github.com/hashicorp/hc-install from 0.6.3 to 0.6.4 (#352)e3fab9a
Strip Provider Prefix from File Names during Migration (#349)836a890
Rewrite Validate Command (#341)221ea1b
Bump github.com/zclconf/go-cty from 1.14.3 to 1.14.4 (#346)5d6fdc8
Bump google.golang.org/protobuf from 1.28.0 to 1.33.0 in /tools (#344)0250fd4
Bump github.com/zclconf/go-cty from 1.14.2 to 1.14.3 (#340)37499d4
Result of tsccr-helper -log-level=info gha update -latest . (#339)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show