cmd/generate: allow HasExample and HasImport to function
#155
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
When building custom templates, we have `HasExample`[1] and `HasImport`[2] available that return a boolean value and allow templates to include conditionals. Some uses of this would be to only show either an example or import line should the files exist. However, when we are calling these for templates both data-sources and resources only pass in an empty string[3] resulting in the value always returning `false`[4]. This appears to be an oversight as the non-customisable render template call site correctly passes in the values[5] of these paths and the template expression renders. [1]: https://github.com/hashicorp/terraform-plugin-docs/blob/6e1a3339859e55625941bcef8ab365552235ca3b/internal/provider/template.go#L137 [2]: https://github.com/hashicorp/terraform-plugin-docs/blob/6e1a3339859e55625941bcef8ab365552235ca3b/internal/provider/template.go#L140 [3]: https://github.com/hashicorp/terraform-plugin-docs/blob/6e1a3339859e55625941bcef8ab365552235ca3b/internal/provider/generate.go#L420 [4]: https://github.com/hashicorp/terraform-plugin-docs/blob/e52e735a834db7cdbd980cc817989588c77d96d4/internal/provider/template.go#L198 [5]: https://github.com/hashicorp/terraform-plugin-docs/blob/6e1a3339859e55625941bcef8ab365552235ca3b/internal/provider/generate.go##L258
jacobbednarz
commented
Jun 20, 2022
jacobbednarz
commented
Jun 20, 2022
detro
previously approved these changes
Jun 23, 2022
|
thanks for the review! appreciate it 🤩 will pop a CHANGELOG entry in when I'm in front of a computer tomorrow morning. |
|
added a CHANGELOG entry with under "Unreleased" - feel free to update this when you know the release date. |
|
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.
When building custom templates, we have
HasExampleandHasImportavailable that return a boolean value and allow templatesto include conditionals. Some uses of this would be to only show either
an example or import line should the files exist. However, when we are
calling these for templates both data-sources and resources only pass in an
empty string resulting in the value always returning
false.This appears to be an oversight as the non-customisable render template
call site correctly passes in the values of these paths and the template
expression renders.