generate: pass through correct name of schema provider #148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacobbednarz
force-pushed
the
use-correct-provider-name
branch
from
c95720f to
2570a93
Compare
After updating to 0.9.0, I found that individual template overrides no longer worked using the `generate` command however, would work if using `tfplugindocs` directly. I started looking into why this was and it boiled down to being that the value from `--rendered-provider-name` was being incorrectly passed into `resourceSchema` causing the friendly name (such as `Cloudflare`) to be used instead of the correct schema name (here, `terraform-provider-cloudflare`) resulting in the schema never being found for the data-source or resource. This corrects the value we pass to the render website methods to always be the schema provider, not the friendly name. Closes hashicorp#139
jacobbednarz
force-pushed
the
use-correct-provider-name
branch
from
2570a93 to
75cbfe9
Compare
|
yep! I'm also leaving the default in the template as I don't think we want this as the default anywhere (even with a fallback) just yet. ideally, people can choose to customise it going forward and it will be work but not forced on anyone. |
elXaptation
reviewed
Jun 13, 2022
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| g.infof("rendering static website") | ||
| err = g.renderStaticWebsite(g.renderedProviderName, providerSchema) | ||
| err = g.renderStaticWebsite(providerName, providerSchema) |
There was a problem hiding this comment.
Perhaps this line shouldn't have change??
There was a problem hiding this comment.
Scratch that.. Doesn't seem to make a difference.
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After updating to 0.9.0, I found that individual template overrides no
longer worked using the
generatecommand however, would work if usingtfplugindocsdirectly. I started looking into why this was and itboiled down to being that the value from
--rendered-provider-namewasbeing incorrectly passed into
resourceSchemacausing the friendly name(such as
Cloudflare) to be used instead of the correct schema name(here,
terraform-provider-cloudflare) resulting in the schema neverbeing found for the data-source or resource. This corrects the value we
pass to the render website methods to always be the schema provider, not
the friendly name.
Closes #139