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

tfplugindocs generates schema that cannot be parsed #580

Closed
Yantrio opened this issue Aug 2, 2022 · 2 comments
Closed

tfplugindocs generates schema that cannot be parsed #580

Yantrio opened this issue Aug 2, 2022 · 2 comments
Assignees
Labels
kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed
Milestone

Comments

@Yantrio
Copy link
Contributor

Yantrio commented Aug 2, 2022

What happened?

The latest version of terraform-plugin-docs introduces a PR that changes attribute names in schema from a strong markdown element to a code element.

hashicorp/terraform-plugin-docs#59

This means that document generation will fail when pointed at a repo that uses the latest version of tfplugindocs.

Steps to reproduce

Try and generate documentation from a repo when it uses the latest version of terraform-plugin-docs.

Expected Behavior

Should parse the documentation

Actual Behavior

Fails to parse with the following error message:

warning: error: Failure in parsing resource name: *RESOURCE*, subsection: ## Schema

Versions used

Latest version of this repo at the time of writing: https://github.com/pulumi/pulumi-terraform-bridge/tree/184df4b22591f1300bc953a979ef9a713dd853e0

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

@Yantrio Yantrio added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Aug 2, 2022
@Yantrio
Copy link
Contributor Author

Yantrio commented Aug 2, 2022

I'll work on a fix for this now and should have a PR up soon

@stack72 stack72 self-assigned this Aug 5, 2022
@stack72 stack72 removed the needs-triage Needs attention from the triage team label Aug 5, 2022
@stack72 stack72 added this to the 0.76 milestone Aug 5, 2022
@stack72 stack72 added the resolution/fixed This issue was fixed label Aug 5, 2022
@stack72
Copy link
Contributor

stack72 commented Aug 5, 2022

Closed via 7719459

@stack72 stack72 closed this as completed Aug 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants