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

fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.20.1 #81

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 14, 2023

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
github.com/hashicorp/terraform-plugin-docs v0.14.1 -> v0.20.1 age adoption passing confidence

Release Notes

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

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)

v0.16.0

Compare Source

ENHANCEMENTS:

  • generate: Prevent files and subdirectories in the rendered website directory that are not directly managed by tfplugindocs from being deleted during generation (#​267)
  • validate: Add cdktf to list of allowed rendered website subdirectories (#​267)

v0.15.0

Compare Source

BREAKING CHANGES:

  • generate: The legacy-sidebar flag has been removed without replacement. It implemented no logic and is not necessary with Terraform Registry based documentation (#​258)

NOTES:

  • This Go module has been updated to Go 1.19 per the Go support policy. Any consumers building on earlier Go versions may experience errors. (#​231)

ENHANCEMENTS:

  • generate: Added provider-dir flag, which enables the command to be run from any directory (#​259)

Configuration

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

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, 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

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 3cd66fc to e7d0092 Compare June 19, 2023 15:40
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from e7d0092 to a36bfa4 Compare July 5, 2023 21:33
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from a36bfa4 to 813fbb2 Compare July 13, 2023 20:08
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.15.0 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.16.0 Jul 13, 2023
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 813fbb2 to 6f830b7 Compare August 31, 2023 21:37
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 6f830b7 to e934c3b Compare September 13, 2023 22:51
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.16.0 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.17.0 Jan 24, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from e934c3b to 1bd8200 Compare January 24, 2024 16:45
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 1bd8200 to 2a985b0 Compare January 31, 2024 18:41
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.17.0 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.18.0 Jan 31, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 2a985b0 to 4b15a58 Compare March 1, 2024 19:43
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch 2 times, most recently from b845c27 to 084a755 Compare April 22, 2024 16:11
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.18.0 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.0 Apr 22, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 084a755 to ff71eda Compare April 29, 2024 15:36
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.0 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.1 Apr 29, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from ff71eda to 5cc3a70 Compare May 6, 2024 22:10
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.1 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.2 May 6, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 5cc3a70 to 73f3b52 Compare May 14, 2024 03:56
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 73f3b52 to dcb73ae Compare May 25, 2024 01:39
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from dcb73ae to 04d2871 Compare June 4, 2024 14:43
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.2 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.3 Jun 4, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch 2 times, most recently from ee11983 to bd24065 Compare June 11, 2024 16:42
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.3 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.4 Jun 11, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from bd24065 to 036135d Compare July 9, 2024 07:02
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch 2 times, most recently from 9bf9bd1 to 0f0c92b Compare August 20, 2024 04:10
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 0f0c92b to fcdf171 Compare August 28, 2024 15:11
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from fcdf171 to 4553fc7 Compare September 12, 2024 04:54
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 4553fc7 to 4e5b3da Compare September 25, 2024 13:51
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch 2 times, most recently from c0780db to 0f2f612 Compare October 9, 2024 22:06
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 0f2f612 to 1e13792 Compare October 23, 2024 16:07
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch 2 times, most recently from ff3cd7a to 47afd20 Compare November 13, 2024 17:27
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.19.4 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.20.0 Nov 13, 2024
Copy link
Contributor Author

renovate bot commented Nov 13, 2024

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

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

Details:

Package Change
go 1.22.0 -> 1.22.7
golang.org/x/sync v0.8.0 -> v0.9.0
golang.org/x/text v0.19.0 -> v0.20.0
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d -> v0.22.0

@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 47afd20 to 115e8fb Compare December 3, 2024 16:15
@renovate renovate bot changed the title fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.20.0 fix(deps): update module github.com/hashicorp/terraform-plugin-docs to v0.20.1 Dec 3, 2024
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch 2 times, most recently from da68f17 to bf1bd9e Compare December 11, 2024 16:18
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from bf1bd9e to 7ed86ff Compare December 18, 2024 19:57
@renovate renovate bot force-pushed the renovate/github.com-hashicorp-terraform-plugin-docs-0.x branch from 7ed86ff to c4b6a62 Compare December 25, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants