hashicorp / terraform-plugin-docs

Generate and validate Terraform plugin/provider documentation.
Mozilla Public License 2.0
224 stars 68 forks source link

configuration is invalid #136

Open adejoux opened 2 years ago

adejoux commented 2 years ago

Hello,

When running tfplugindocs inside my terraform plugin I have this error:

tfplugindocs.exe generate 
rendering website for provider "terraform_ccc_provider"
exporting schema from Terraform
compiling provider "terraform_ccc_provider"
using Terraform CLI binary from PATH if available, otherwise downloading latest Terraform CLI binary
running terraform init
Error executing command: unable to generate website: configuration is invalid

I cannot get any information on what is invalid and what this tool is expecting. Would be nice to have more informations on this kind of errors.

Can you help me?

Regards

lrstanley commented 2 years ago

Hello @adejoux, if https://github.com/hashicorp/terraform-plugin-docs/pull/174 is merged, it should help improve the error output from terraform itself.

I believe the issue you are likely running into is the provider name, which I don't believe can have an underscore. When I tried locally with an underscore, terraform threw an error.