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

Bump github.com/hashicorp/terraform-plugin-docs from 0.18.0 to 0.19.0 #324

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 22, 2024

Bumps github.com/hashicorp/terraform-plugin-docs from 0.18.0 to 0.19.0.

Release notes

Sourced from github.com/hashicorp/terraform-plugin-docs's releases.

v0.19.0

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)
Changelog

Sourced from github.com/hashicorp/terraform-plugin-docs's changelog.

0.19.0 (April 15, 2024)

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)
Commits
  • 45dd248 Update changelog
  • 1f28b7c Move schemamd and functionmd packages to internal (#354)
  • ab779d3 calc path in title next to anchorID (#350)
  • e7e94b3 Bump github.com/hashicorp/hc-install from 0.6.3 to 0.6.4 (#352)
  • e3fab9a Strip Provider Prefix from File Names during Migration (#349)
  • 836a890 Rewrite Validate Command (#341)
  • 221ea1b Bump github.com/zclconf/go-cty from 1.14.3 to 1.14.4 (#346)
  • 5d6fdc8 Bump google.golang.org/protobuf from 1.28.0 to 1.33.0 in /tools (#344)
  • 0250fd4 Bump github.com/zclconf/go-cty from 1.14.2 to 1.14.3 (#340)
  • 37499d4 Result of tsccr-helper -log-level=info gha update -latest . (#339)
  • 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.18.0 to 0.19.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.18.0...v0.19.0)

---
updated-dependencies:
- dependency-name: github.com/hashicorp/terraform-plugin-docs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Apr 22, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Apr 29, 2024

Superseded by #326.

@dependabot dependabot bot closed this Apr 29, 2024
@dependabot dependabot bot deleted the dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.19.0 branch April 29, 2024 08:25
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants