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)
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)
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)
You can trigger a rebase of this PR 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)
Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.
Bumps github.com/hashicorp/terraform-plugin-docs from 0.16.0 to 0.18.0.
Release notes
Sourced from github.com/hashicorp/terraform-plugin-docs's releases.
Changelog
Sourced from github.com/hashicorp/terraform-plugin-docs's changelog.
Commits
4c08c0e
Update changelog69163cd
Add Support for Provider-defined Function Documentation (#328)56c7fae
Bump github.com/hashicorp/terraform-json from 0.20.0 to 0.21.0 (#325)1856bda
Update changelog6dec712
Bump github.com/rogpeppe/go-internal from 1.11.0 to 1.12.0 (#306)042eb55
Document the default behavior of--tf-version
and usage of Terraform binary...2e13971
deps: Migrate to github.com/hashicorp/cli (#322)eff4087
Update README.md - addtools.go
quick example (#289)068a226
Implementmigrate
sub-command (#314)8456c0c
Bump github.com/hashicorp/terraform-json from 0.18.0 to 0.20.0 (#315)You can trigger a rebase of this PR 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