Update module github.com/hashicorp/terraform-plugin-docs to v0.24.0

[red-hat-konflux]

This PR contains the following updates:

Package	Change	Age	Confidence
github.com/hashicorp/terraform-plugin-docs	v0.16.0 -> v0.24.0

---

Warning

Some dependencies could not be looked up. Check the warning logs for more information.

---

Release Notes

hashicorp/terraform-plugin-docs (github.com/hashicorp/terraform-plugin-docs)

v0.24.0

Compare Source

FEATURES:

• generate: Support multiple configuration example files in default templates (#​508)
• generate/migrate/validate: Add support for list resources (#​528)

v0.23.0

Compare Source

FEATURES:

• generate: Add support for actions (#​505)
• migrate: Add support for actions (#​505)
• validate: Add support for actions (#​505)

v0.22.0

Compare Source

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)

v0.21.0

Compare Source

FEATURES:

• generate: Add support for write-only arguments (#​434)

v0.20.1

Compare Source

BUG FIXES:

• validate: Fixed a bug that caused false positive validation errors for resource types that have the same name as the provider. (#​419)
• generate: Fixed a bug that caused all generated resource documentation to have the same content when the provider has a resource type with the same name as the provider. (#​419)
• generate: Fixed a bug that would return an error when a static file exists in both templates and docs, which will now be ignored. (#​421)

v0.20.0

Compare Source

NOTES:

• all: This Go module has been updated to Go 1.22 per the Go support policy. It is recommended to review the Go 1.22 release notes before upgrading. Any consumers building on earlier Go versions may experience errors. (#​400)

FEATURES:

• generate: Add support for ephemeral resources (#​415)
• migrate: Add support for ephemeral resources (#​415)
• validate: Add support for ephemeral resources (#​415)

BUG FIXES:

• validate: File extension check now runs on index.* files instead of just index.md files. (#​413)
• validate: File extension check now specifies the correct valid extensions in the error message. (#​413)
• validate: Front matter check now runs with the correct options on legacy index files. (#​413)

v0.19.4

Compare Source

NOTES:

• validate: The number of files check has been removed to match the latest Terraform Registry ingress logic (#​381)

BUG FIXES:

• generate: Prevented incorrect attribute paths with nested attributes that contain multiple attributes (#​380)

v0.19.3

Compare Source

BUG FIXES:

• validate: Fixed issue with provider name not defaulting to directory (#​376)

v0.19.2

Compare Source

BUG FIXES:

• migrate: Ensured idempotency of template files when command is ran multiple times (#​364)
• generate: Prevented automatic id attribute behaviors under blocks (#​365)

v0.19.1

Compare Source

BUG FIXES:

• generate: fixed a bug where attribute titles were not being generated for nested object attributes (#​357)
• generate: fixed a bug where the plainmarkdown function did not output plain URLs (#​361)

v0.19.0

Compare Source

BREAKING CHANGES:

• generate: the plainmarkdown function now removes all markdown elements/formatting to render the output as plain text (#​332)
• 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

Compare Source

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

Compare Source

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)

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

To execute skipped test pipelines write comment /ok-to-test.

---

Documentation

Find out how to configure dependency updates in MintMaker documentation or see all available configuration options in Renovate documentation.

[red-hat-konflux]

ℹ Artifact update notice

File name: go.mod

In order to perform the update(s) described in the table above, Renovate ran the go get command, which resulted in the following additional change(s):

• 16 additional dependencies were updated
• The go directive was updated for compatibility reasons

Details:

Package	Change
go	1.23.0 -> 1.24.0
go (toolchain)	1.23.9 -> 1.24.6
github.com/hashicorp/go-version	v1.6.0 -> v1.7.0
golang.org/x/net	v0.43.0 -> v0.44.0
golang.org/x/sync	v0.16.0 -> v0.17.0
golang.org/x/sys	v0.35.0 -> v0.36.0
github.com/ProtonMail/go-crypto	v1.1.0-alpha.2 -> v1.1.6
github.com/cloudflare/circl	v1.3.7 -> v1.6.1
github.com/hashicorp/go-hclog	v1.5.0 -> v1.6.3
github.com/hashicorp/hc-install	v0.6.4 -> v0.9.2
github.com/hashicorp/terraform-exec	v0.21.0 -> v0.24.0
github.com/hashicorp/terraform-json	v0.22.1 -> v0.27.2
github.com/mattn/go-colorable	v0.1.13 -> v0.1.14
github.com/zclconf/go-cty	v1.14.4 -> v1.17.0
golang.org/x/crypto	v0.41.0 -> v0.42.0
golang.org/x/mod	v0.26.0 -> v0.28.0
golang.org/x/text	v0.28.0 -> v0.30.0
golang.org/x/tools	v0.35.0 -> v0.37.0

[openshift-ci]

Hi @red-hat-konflux[bot]. Thanks for your PR.

I'm waiting for a terraform-redhat member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign hunterkepley for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment