Cannot create Terraform documentation as per Plugin Development Guide

darkedges · July 10, 2021, 11:46pm

When I follow the docs @ Home - Plugin Development: SDKv2 | Terraform | HashiCorp Developer to create the documentation I run into the following

xxxx@xxxx-iMac terraform-provider-fram % go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

cannot find package “.” in:
/Users/xxxxxx/go/src/github.com/darkedges/terraform-provider-fram/vendor/github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

xxxx@xxxx-iMac terraform-provider-fram % go version

go version go1.16.5 darwin/amd64

I have followed the guide, but may have missed something.

Any ideas?

Regards
Nicholas Irving

darkedges · July 11, 2021, 2:38am

I moved it away from $GOPATH/src, removed the vendors directory and updated to use in main.go

//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs

github.com

darkedges/terraform-provider-fram/blob/main/main.go#L9


      
          package main
          
          import (
          	"github.com/darkedges/terraform-provider-fram/fram"
          	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
          	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
          )
          
          //go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
          
          func main() {
          	plugin.Serve(&plugin.ServeOpts{
          		ProviderFunc: func() *schema.Provider {
          			return fram.Provider()
          		},
          	})
          }

All seems to be working now.

Topic		Replies	Views
Why is it that almost no one uses terraform-plugin-docs? Including Hashicorp! Plugin Development	2	68	July 29, 2024
Error while trying to use terraform-plugin-sdk Plugin Development	2	3265	January 20, 2020
Guide on Provider Development Plugin Development	2	385	July 29, 2022
Trying to use a provider plugin directly with the RPC API is impossible without proper documentation Terraform Providers	0	19	December 15, 2024
How to document import with terraform-plugin-docs? Terraform Providers	0	270	April 21, 2021

Cannot create Terraform documentation as per Plugin Development Guide

Related topics