Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump github.com/hashicorp/terraform-plugin-docs from 0.16.0 to 0.17.0 #294

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 22, 2024

Bumps github.com/hashicorp/terraform-plugin-docs from 0.16.0 to 0.17.0.

Release notes

Sourced from github.com/hashicorp/terraform-plugin-docs's releases.

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

Sourced from github.com/hashicorp/terraform-plugin-docs's changelog.

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)
Commits
  • 1856bda Update changelog
  • 6dec712 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 - add tools.go quick example (#289)
  • 068a226 Implement migrate sub-command (#314)
  • 8456c0c Bump github.com/hashicorp/terraform-json from 0.18.0 to 0.20.0 (#315)
  • 8b2a706 Bump github.com/hashicorp/terraform-exec from 0.19.0 to 0.20.0 (#313)
  • de5265b Bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 (#319)
  • 0db8e4f Bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 in /tools (#320)
  • Additional commits viewable in compare view

Dependabot compatibility score

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 <dependency name> 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](https://github.com/hashicorp/terraform-plugin-docs) from 0.16.0 to 0.17.0.
- [Release notes](https://github.com/hashicorp/terraform-plugin-docs/releases)
- [Changelog](https://github.com/hashicorp/terraform-plugin-docs/blob/main/CHANGELOG.md)
- [Commits](hashicorp/terraform-plugin-docs@v0.16.0...v0.17.0)

---
updated-dependencies:
- dependency-name: github.com/hashicorp/terraform-plugin-docs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jan 22, 2024
@ddelnano ddelnano merged commit f1de0f0 into master Jan 22, 2024
4 checks passed
@ddelnano ddelnano deleted the dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.17.0 branch January 22, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant