Skip to content

Conversation

@dependabot
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)

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 added dependencies Pull requests that update a dependency file go Pull requests that update go code labels Jul 7, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jul 7, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the terraform-plugin-docs dependency from version 0.21.0 to 0.22.0, which includes new features for import documentation generation and template improvements.

Key changes:

  • Updates terraform-plugin-docs from v0.21.0 to v0.22.0
  • Updates several indirect dependencies to newer versions
  • Introduces potential breaking changes in template function behavior

github.com/golang/mock v1.6.0
github.com/hashicorp/go-cty v1.5.0
github.com/hashicorp/terraform-plugin-docs v0.21.0
github.com/hashicorp/terraform-plugin-docs v0.22.0
Copy link

Copilot AI Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This version update introduces a breaking change where .ProviderShortName template function behavior has changed. Ensure that any custom templates using this function are tested and updated if necessary, especially if the --rendered-provider-name flag is used in your documentation generation.

Suggested change
github.com/hashicorp/terraform-plugin-docs v0.22.0
github.com/hashicorp/terraform-plugin-docs v0.23.0

Copilot uses AI. Check for mistakes.
@scott-the-programmer scott-the-programmer merged commit 9095c3c into main Jul 29, 2025
2 checks passed
@scott-the-programmer scott-the-programmer deleted the dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.22.0 branch July 29, 2025 12:44
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.

2 participants