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

Update module github.com/hashicorp/terraform-plugin-docs to v0.21.0 #874

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

red-hat-konflux[bot]
Copy link
Contributor

This PR contains the following updates:

Package Type Update Change
github.com/hashicorp/terraform-plugin-docs require minor v0.16.0 -> v0.21.0

Release Notes

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

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 - "after 5am on sunday" (UTC), 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.

This PR has been generated by MintMaker (powered by Renovate Bot).

Signed-off-by: red-hat-konflux <126015336+red-hat-konflux[bot]@users.noreply.github.com>
Copy link
Contributor Author

ℹ 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):

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

Details:

Package Change
go 1.21 -> 1.22.9
github.com/hashicorp/go-version v1.6.0 -> v1.7.0
golang.org/x/sync v0.7.0 -> v0.11.0
golang.org/x/sys v0.22.0 -> v0.29.0
github.com/ProtonMail/go-crypto v1.1.0-alpha.2 -> v1.1.3
github.com/hashicorp/go-hclog v1.5.0 -> v1.6.3
github.com/hashicorp/hc-install v0.6.4 -> v0.9.1
github.com/hashicorp/terraform-exec v0.21.0 -> v0.22.0
github.com/hashicorp/terraform-json v0.22.1 -> v0.24.0
github.com/mattn/go-colorable v0.1.13 -> v0.1.14
github.com/zclconf/go-cty v1.14.4 -> v1.16.2
golang.org/x/crypto v0.25.0 -> v0.32.0
golang.org/x/mod v0.17.0 -> v0.22.0
golang.org/x/text v0.16.0 -> v0.22.0
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d -> v0.22.0

@openshift-ci openshift-ci bot requested review from nirarg and radtriste March 2, 2025 12:10
Copy link

openshift-ci bot commented Mar 2, 2025

[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 gdbranco 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:

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

Copy link

openshift-ci bot commented Mar 2, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants