Skip to content

Draft: tools/tools: Update module github.com/hashicorp/terraform-plugin-docs to v0.19.1

GitLab Dependency Bot requested to merge gitlab-renovate-forks/terraform-provider-gitlab:renovate-tools/tools/github.com-hashicorp-terraform-plugin-docs-0.x into main

This MR contains the following updates:

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

MR created with the help of gitlab-org/frontend/renovate-gitlab-bot

Release Notes

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

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)

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 MR becomes conflicted, or you tick the rebase/retry checkbox.

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

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

This MR has been generated by Renovate Bot.

Merge request reports