Skip to content

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 7, 2025

Bumps github.com/hashicorp/terraform-plugin-docs from 0.21.0 to 0.22.0.

Release notes

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

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

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

0.22.0 (July 01, 2025)

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)
Commits
  • 0be94a7 Update changelog
  • 5db5509 generate: Add support for import configuration examples with identity + sch...
  • 3b9b212 generate: Add support for import configuration examples with the id attri...
  • 31cddc7 Revert "Bump github.com/yuin/goldmark from 1.7.7 to 1.7.12 (#484)" (#498)
  • 9ff8b91 Dependabot: Single weekly PR for GH Actions, Single PR for terraform-plugin-*...
  • 0367702 Generate: Use rendered provider name instead of provider name in default temp...
  • 8b2645d Bump github.com/yuin/goldmark from 1.7.7 to 1.7.12 (#484)
  • 2f25d2c fix: remove double newlines when no variadic argument (#489)
  • 2ffec57 Remove subcategory field from frontmatter in default provider template. (#446)
  • 20d5937 Bump github.com/cloudflare/circl from 1.6.0 to 1.6.1 (#491)
  • 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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file go Pull requests that update Go code labels Jul 7, 2025
Bumps [github.com/hashicorp/terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs) from 0.21.0 to 0.22.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.21.0...v0.22.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.22.0 branch from 0635560 to ffd1d09 Compare July 8, 2025 05:40
@ethanndickson ethanndickson merged commit 6ae387f into main Jul 8, 2025
13 checks passed
@ethanndickson ethanndickson deleted the dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.22.0 branch July 8, 2025 05:49
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 go Pull requests that update Go code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant