Merge pull request #43 from Lerentis/dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.15.0

Bump github.com/hashicorp/terraform-plugin-docs from 0.14.1 to 0.15.0

go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	code.gitea.io/sdk/gitea v0.15.1
-	github.com/hashicorp/terraform-plugin-docs v0.14.1
+	github.com/hashicorp/terraform-plugin-docs v0.15.0
 	github.com/hashicorp/terraform-plugin-log v0.9.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.27.0
 )

go.sum

@@ -84,8 +84,8 @@ github.com/hashicorp/terraform-exec v0.18.1 h1:LAbfDvNQU1l0NOQlTuudjczVhHj061fNX
 github.com/hashicorp/terraform-exec v0.18.1/go.mod h1:58wg4IeuAJ6LVsLUeD2DWZZoc/bYi6dzhLHzxM41980=
 github.com/hashicorp/terraform-json v0.17.0 h1:EiA1Wp07nknYQAiv+jIt4dX4Cq5crgP+TsTE45MjMmM=
 github.com/hashicorp/terraform-json v0.17.0/go.mod h1:Huy6zt6euxaY9knPAFKjUITn8QxUFIe9VuSzb4zn/0o=
-github.com/hashicorp/terraform-plugin-docs v0.14.1 h1:MikFi59KxrP/ewrZoaowrB9he5Vu4FtvhamZFustiA4=
-github.com/hashicorp/terraform-plugin-docs v0.14.1/go.mod h1:k2NW8+t113jAus6bb5tQYQgEAX/KueE/u8X2Z45V1GM=
+github.com/hashicorp/terraform-plugin-docs v0.15.0 h1:W5xYB5kCUBqO7lyjE2UMmUBh95c0aAf4jwO0Xuuw2Ec=
+github.com/hashicorp/terraform-plugin-docs v0.15.0/go.mod h1:K5Taof1Y7sL4dw6Ie0qMFyQnHN0W+RSVMD0iIyFDFJc=
 github.com/hashicorp/terraform-plugin-go v0.16.0 h1:DSOQ0rz5FUiVO4NUzMs8ln9gsPgHMTsfns7Nk+6gPuE=
 github.com/hashicorp/terraform-plugin-go v0.16.0/go.mod h1:4sn8bFuDbt+2+Yztt35IbOrvZc0zyEi87gJzsTgCES8=
 github.com/hashicorp/terraform-plugin-log v0.9.0 h1:i7hOA+vdAItN1/7UrfBqBwvYPQ9TFvymaRGZED3FCV0=

vendor/github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs/main.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package main
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs/version.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package main
 
 var (

vendor/github.com/hashicorp/terraform-plugin-docs/internal/cmd/generate.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package cmd
 
 import (
@@ -11,12 +14,12 @@ import (
 type generateCmd struct {
 	commonCmd
 
-	flagLegacySidebar    bool
 	flagIgnoreDeprecated bool
 
 	flagProviderName         string
 	flagRenderedProviderName string
 
+	flagProviderDir        string
 	flagRenderedWebsiteDir string
 	flagExamplesDir        string
 	flagWebsiteTmpDir      string
@@ -25,7 +28,7 @@ type generateCmd struct {
 }
 
 func (cmd *generateCmd) Synopsis() string {
-	return "generates a plugin website from code, templates, and examples for the current directory"
+	return "generates a plugin website from code, templates, and examples"
 }
 
 func (cmd *generateCmd) Help() string {
@@ -68,13 +71,13 @@ func (cmd *generateCmd) Help() string {
 
 func (cmd *generateCmd) Flags() *flag.FlagSet {
 	fs := flag.NewFlagSet("generate", flag.ExitOnError)
-	fs.BoolVar(&cmd.flagLegacySidebar, "legacy-sidebar", false, "generate the legacy .erb sidebar file")
 	fs.StringVar(&cmd.flagProviderName, "provider-name", "", "provider name, as used in Terraform configurations")
+	fs.StringVar(&cmd.flagProviderDir, "provider-dir", "", "relative or absolute path to the root provider code directory when running the command outside the root provider code directory")
 	fs.StringVar(&cmd.flagRenderedProviderName, "rendered-provider-name", "", "provider name, as generated in documentation (ex. page titles, ...)")
-	fs.StringVar(&cmd.flagRenderedWebsiteDir, "rendered-website-dir", "docs", "output directory")
-	fs.StringVar(&cmd.flagExamplesDir, "examples-dir", "examples", "examples directory")
+	fs.StringVar(&cmd.flagRenderedWebsiteDir, "rendered-website-dir", "docs", "output directory based on provider-dir")
+	fs.StringVar(&cmd.flagExamplesDir, "examples-dir", "examples", "examples directory based on provider-dir")
 	fs.StringVar(&cmd.flagWebsiteTmpDir, "website-temp-dir", "", "temporary directory (used during generation)")
-	fs.StringVar(&cmd.flagWebsiteSourceDir, "website-source-dir", "templates", "templates directory")
+	fs.StringVar(&cmd.flagWebsiteSourceDir, "website-source-dir", "templates", "templates directory based on provider-dir")
 	fs.StringVar(&cmd.tfVersion, "tf-version", "", "terraform binary version to download")
 	fs.BoolVar(&cmd.flagIgnoreDeprecated, "ignore-deprecated", false, "don't generate documentation for deprecated resources and data-sources")
 	return fs
@@ -94,7 +97,7 @@ func (cmd *generateCmd) Run(args []string) int {
 func (cmd *generateCmd) runInternal() error {
 	err := provider.Generate(
 		cmd.ui,
-		cmd.flagLegacySidebar,
+		cmd.flagProviderDir,
 		cmd.flagProviderName,
 		cmd.flagRenderedProviderName,
 		cmd.flagRenderedWebsiteDir,

vendor/github.com/hashicorp/terraform-plugin-docs/internal/cmd/run.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package cmd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/internal/cmd/serve.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package cmd
 
 //TODO: this command can run an emulated server to simulate the registry

vendor/github.com/hashicorp/terraform-plugin-docs/internal/cmd/validate.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package cmd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/internal/mdplain/mdplain.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package mdplain
 
 import "github.com/russross/blackfriday"

vendor/github.com/hashicorp/terraform-plugin-docs/internal/mdplain/renderer.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package mdplain
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/internal/provider/generate.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package provider
 
 import (
@@ -64,15 +67,17 @@ var (
 
 type generator struct {
 	ignoreDeprecated bool
-	legacySidebar    bool
 	tfVersion        string
 
+	// providerDir is the absolute path to the root provider directory
+	providerDir string
+
 	providerName         string
 	renderedProviderName string
 	renderedWebsiteDir   string
 	examplesDir          string
+	templatesDir         string
 	websiteTmpDir        string
-	websiteSourceDir     string
 
 	ui cli.Ui
 }
@@ -85,18 +90,48 @@ func (g *generator) warnf(format string, a ...interface{}) {
 	g.ui.Warn(fmt.Sprintf(format, a...))
 }
 
-func Generate(ui cli.Ui, legacySidebar bool, providerName, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, websiteSourceDir, tfVersion string, ignoreDeprecated bool) error {
+func Generate(ui cli.Ui, providerDir, providerName, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, templatesDir, tfVersion string, ignoreDeprecated bool) error {
+	// Ensure provider directory is resolved absolute path
+	if providerDir == "" {
+		wd, err := os.Getwd()
+
+		if err != nil {
+			return fmt.Errorf("error getting working directory: %w", err)
+		}
+
+		providerDir = wd
+	} else {
+		absProviderDir, err := filepath.Abs(providerDir)
+
+		if err != nil {
+			return fmt.Errorf("error getting absolute path with provider directory %q: %w", providerDir, err)
+		}
+
+		providerDir = absProviderDir
+	}
+
+	// Verify provider directory
+	providerDirFileInfo, err := os.Stat(providerDir)
+
+	if err != nil {
+		return fmt.Errorf("error getting information for provider directory %q: %w", providerDir, err)
+	}
+
+	if !providerDirFileInfo.IsDir() {
+		return fmt.Errorf("expected %q to be a directory", providerDir)
+	}
+
 	g := &generator{
 		ignoreDeprecated: ignoreDeprecated,
-		legacySidebar:    legacySidebar,
 		tfVersion:        tfVersion,
 
+		providerDir:          providerDir,
 		providerName:         providerName,
 		renderedProviderName: renderedProviderName,
 		renderedWebsiteDir:   renderedWebsiteDir,
 		examplesDir:          examplesDir,
+		templatesDir:         templatesDir,
 		websiteTmpDir:        websiteTmpDir,
-		websiteSourceDir:     websiteSourceDir,
 
 		ui: ui,
 	}
@@ -109,14 +144,9 @@ func Generate(ui cli.Ui, legacySidebar bool, providerName, renderedProviderName,
 func (g *generator) Generate(ctx context.Context) error {
 	var err error
 
-	wd, err := os.Getwd()
-	if err != nil {
-		return err
-	}
-
 	providerName := g.providerName
 	if g.providerName == "" {
-		providerName = filepath.Base(wd)
+		providerName = filepath.Base(g.providerDir)
 	}
 
 	if g.renderedProviderName == "" {
@@ -146,19 +176,19 @@ func (g *generator) Generate(ctx context.Context) error {
 		}
 	}
 
-	websiteSourceDirInfo, err := os.Stat(g.websiteSourceDir)
+	templatesDirInfo, err := os.Stat(g.ProviderTemplatesDir())
 	switch {
 	case os.IsNotExist(err):
 		// do nothing, no template dir
 	case err != nil:
 		return err
 	default:
-		if !websiteSourceDirInfo.IsDir() {
-			return fmt.Errorf("template path is not a directory: %s", g.websiteSourceDir)
+		if !templatesDirInfo.IsDir() {
+			return fmt.Errorf("template path is not a directory: %s", g.ProviderTemplatesDir())
 		}
 
 		g.infof("copying any existing content to tmp dir")
-		err = cp(g.websiteSourceDir, filepath.Join(g.websiteTmpDir, "templates"))
+		err = cp(g.ProviderTemplatesDir(), g.TempTemplatesDir())
 		if err != nil {
 			return err
 		}
@@ -182,44 +212,63 @@ func (g *generator) Generate(ctx context.Context) error {
 		return err
 	}
 
-	// TODO: may not ever need this, unsure on when this will go live
-	if g.legacySidebar {
-		g.infof("rendering legacy sidebar...")
-		g.warnf("TODO...!")
-	}
-
 	return nil
 }
 
+// ProviderDocsDir returns the absolute path to the joined provider and
+// given website documentation directory, which defaults to "docs".
+func (g generator) ProviderDocsDir() string {
+	return filepath.Join(g.providerDir, g.renderedWebsiteDir)
+}
+
+// ProviderExamplesDir returns the absolute path to the joined provider and
+// given examples directory, which defaults to "examples".
+func (g generator) ProviderExamplesDir() string {
+	return filepath.Join(g.providerDir, g.examplesDir)
+}
+
+// ProviderTemplatesDir returns the absolute path to the joined provider and
+// given templates directory, which defaults to "templates".
+func (g generator) ProviderTemplatesDir() string {
+	return filepath.Join(g.providerDir, g.templatesDir)
+}
+
+// TempTemplatesDir returns the absolute path to the joined temporary and
+// hardcoded "templates" sub-directory, which is where provider templates are
+// copied.
+func (g generator) TempTemplatesDir() string {
+	return filepath.Join(g.websiteTmpDir, "templates")
+}
+
 func (g *generator) renderMissingResourceDoc(providerName, name, typeName string, schema *tfjson.Schema, websiteFileTemplate resourceFileTemplate, fallbackWebsiteFileTemplate resourceFileTemplate, websiteStaticCandidateTemplates []resourceFileTemplate, examplesFileTemplate resourceFileTemplate, examplesImportTemplate *resourceFileTemplate) error {
-	tmplPath, err := websiteFileTemplate.Render(name, providerName)
+	tmplPath, err := websiteFileTemplate.Render(g.providerDir, name, providerName)
 	if err != nil {
 		return fmt.Errorf("unable to render path for resource %q: %w", name, err)
 	}
-	tmplPath = filepath.Join(g.websiteTmpDir, g.websiteSourceDir, tmplPath)
+	tmplPath = filepath.Join(g.TempTemplatesDir(), tmplPath)
 	if fileExists(tmplPath) {
 		g.infof("resource %q template exists, skipping", name)
 		return nil
 	}
 
 	for _, candidate := range websiteStaticCandidateTemplates {
-		candidatePath, err := candidate.Render(name, providerName)
+		candidatePath, err := candidate.Render(g.providerDir, name, providerName)
 		if err != nil {
 			return fmt.Errorf("unable to render path for resource %q: %w", name, err)
 		}
-		candidatePath = filepath.Join(g.websiteTmpDir, g.websiteSourceDir, candidatePath)
+		candidatePath = filepath.Join(g.TempTemplatesDir(), candidatePath)
 		if fileExists(candidatePath) {
 			g.infof("resource %q static file exists, skipping", name)
 			return nil
 		}
 	}
 
-	examplePath, err := examplesFileTemplate.Render(name, providerName)
+	examplePath, err := examplesFileTemplate.Render(g.providerDir, name, providerName)
 	if err != nil {
 		return fmt.Errorf("unable to render example file path for %q: %w", name, err)
 	}
 	if examplePath != "" {
-		examplePath = filepath.Join(g.examplesDir, examplePath)
+		examplePath = filepath.Join(g.ProviderExamplesDir(), examplePath)
 	}
 	if !fileExists(examplePath) {
 		examplePath = ""
@@ -227,12 +276,12 @@ func (g *generator) renderMissingResourceDoc(providerName, name, typeName string
 
 	importPath := ""
 	if examplesImportTemplate != nil {
-		importPath, err = examplesImportTemplate.Render(name, providerName)
+		importPath, err = examplesImportTemplate.Render(g.providerDir, name, providerName)
 		if err != nil {
 			return fmt.Errorf("unable to render example import file path for %q: %w", name, err)
 		}
 		if importPath != "" {
-			importPath = filepath.Join(g.examplesDir, importPath)
+			importPath = filepath.Join(g.ProviderExamplesDir(), importPath)
 		}
 		if !fileExists(importPath) {
 			importPath = ""
@@ -241,11 +290,11 @@ func (g *generator) renderMissingResourceDoc(providerName, name, typeName string
 
 	targetResourceTemplate := defaultResourceTemplate
 
-	fallbackTmplPath, err := fallbackWebsiteFileTemplate.Render(name, providerName)
+	fallbackTmplPath, err := fallbackWebsiteFileTemplate.Render(g.providerDir, name, providerName)
 	if err != nil {
 		return fmt.Errorf("unable to render path for resource %q: %w", name, err)
 	}
-	fallbackTmplPath = filepath.Join(g.websiteTmpDir, g.websiteSourceDir, fallbackTmplPath)
+	fallbackTmplPath = filepath.Join(g.TempTemplatesDir(), fallbackTmplPath)
 	if fileExists(fallbackTmplPath) {
 		g.infof("resource %q fallback template exists", name)
 		tmplData, err := os.ReadFile(fallbackTmplPath)
@@ -256,7 +305,7 @@ func (g *generator) renderMissingResourceDoc(providerName, name, typeName string
 	}
 
 	g.infof("generating template for %q", name)
-	md, err := targetResourceTemplate.Render(name, providerName, g.renderedProviderName, typeName, examplePath, importPath, schema)
+	md, err := targetResourceTemplate.Render(g.providerDir, name, providerName, g.renderedProviderName, typeName, examplePath, importPath, schema)
 	if err != nil {
 		return fmt.Errorf("unable to render template for %q: %w", name, err)
 	}
@@ -270,41 +319,41 @@ func (g *generator) renderMissingResourceDoc(providerName, name, typeName string
 }
 
 func (g *generator) renderMissingProviderDoc(providerName string, schema *tfjson.Schema, websiteFileTemplate providerFileTemplate, websiteStaticCandidateTemplates []providerFileTemplate, examplesFileTemplate providerFileTemplate) error {
-	tmplPath, err := websiteFileTemplate.Render(providerName)
+	tmplPath, err := websiteFileTemplate.Render(g.providerDir, providerName)
 	if err != nil {
 		return fmt.Errorf("unable to render path for provider %q: %w", providerName, err)
 	}
-	tmplPath = filepath.Join(g.websiteTmpDir, g.websiteSourceDir, tmplPath)
+	tmplPath = filepath.Join(g.TempTemplatesDir(), tmplPath)
 	if fileExists(tmplPath) {
 		g.infof("provider %q template exists, skipping", providerName)
 		return nil
 	}
 
 	for _, candidate := range websiteStaticCandidateTemplates {
-		candidatePath, err := candidate.Render(providerName)
+		candidatePath, err := candidate.Render(g.providerDir, providerName)
 		if err != nil {
 			return fmt.Errorf("unable to render path for provider %q: %w", providerName, err)
 		}
-		candidatePath = filepath.Join(g.websiteTmpDir, g.websiteSourceDir, candidatePath)
+		candidatePath = filepath.Join(g.TempTemplatesDir(), candidatePath)
 		if fileExists(candidatePath) {
 			g.infof("provider %q static file exists, skipping", providerName)
 			return nil
 		}
 	}
 
-	examplePath, err := examplesFileTemplate.Render(providerName)
+	examplePath, err := examplesFileTemplate.Render(g.providerDir, providerName)
 	if err != nil {
 		return fmt.Errorf("unable to render example file path for %q: %w", providerName, err)
 	}
 	if examplePath != "" {
-		examplePath = filepath.Join(g.examplesDir, examplePath)
+		examplePath = filepath.Join(g.ProviderExamplesDir(), examplePath)
 	}
 	if !fileExists(examplePath) {
 		examplePath = ""
 	}
 
 	g.infof("generating template for %q", providerName)
-	md, err := defaultProviderTemplate.Render(providerName, g.renderedProviderName, examplePath, schema)
+	md, err := defaultProviderTemplate.Render(g.providerDir, providerName, g.renderedProviderName, examplePath, schema)
 	if err != nil {
 		return fmt.Errorf("unable to render template for %q: %w", providerName, err)
 	}
@@ -367,7 +416,7 @@ func (g *generator) renderMissingDocs(providerName string, providerSchema *tfjso
 
 func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfjson.ProviderSchema) error {
 	g.infof("cleaning rendered website dir")
-	err := os.RemoveAll(g.renderedWebsiteDir)
+	err := os.RemoveAll(g.ProviderDocsDir())
 	if err != nil {
 		return err
 	}
@@ -382,7 +431,7 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 			return nil
 		}
 
-		rel, err := filepath.Rel(filepath.Join(g.websiteTmpDir, g.websiteSourceDir), path)
+		rel, err := filepath.Rel(filepath.Join(g.TempTemplatesDir()), path)
 		if err != nil {
 			return err
 		}
@@ -395,7 +444,7 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 			return nil
 		}
 
-		renderedPath := filepath.Join(g.renderedWebsiteDir, rel)
+		renderedPath := filepath.Join(g.ProviderDocsDir(), rel)
 		err = os.MkdirAll(filepath.Dir(renderedPath), 0755)
 		if err != nil {
 			return err
@@ -424,10 +473,11 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 		switch relDir {
 		case "data-sources/":
 			resSchema, resName := resourceSchema(providerSchema.DataSourceSchemas, shortName, relFile)
-			exampleFilePath := filepath.Join(g.examplesDir, "data-sources", resName, "data-source.tf")
+			exampleFilePath := filepath.Join(g.ProviderExamplesDir(), "data-sources", resName, "data-source.tf")
+
 			if resSchema != nil {
 				tmpl := resourceTemplate(tmplData)
-				render, err := tmpl.Render(resName, providerName, g.renderedProviderName, "Data Source", exampleFilePath, "", resSchema)
+				render, err := tmpl.Render(g.providerDir, resName, providerName, g.renderedProviderName, "Data Source", exampleFilePath, "", resSchema)
 				if err != nil {
 					return fmt.Errorf("unable to render data source template %q: %w", rel, err)
 				}
@@ -440,12 +490,12 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 			g.warnf("data source entitled %q, or %q does not exist", shortName, resName)
 		case "resources/":
 			resSchema, resName := resourceSchema(providerSchema.ResourceSchemas, shortName, relFile)
-			exampleFilePath := filepath.Join(g.examplesDir, "resources", resName, "resource.tf")
-			importFilePath := filepath.Join(g.examplesDir, "resources", resName, "import.sh")
+			exampleFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "resource.tf")
+			importFilePath := filepath.Join(g.ProviderExamplesDir(), "resources", resName, "import.sh")
 
 			if resSchema != nil {
 				tmpl := resourceTemplate(tmplData)
-				render, err := tmpl.Render(resName, providerName, g.renderedProviderName, "Resource", exampleFilePath, importFilePath, resSchema)
+				render, err := tmpl.Render(g.providerDir, resName, providerName, g.renderedProviderName, "Resource", exampleFilePath, importFilePath, resSchema)
 				if err != nil {
 					return fmt.Errorf("unable to render resource template %q: %w", rel, err)
 				}
@@ -459,8 +509,8 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 		case "": // provider
 			if relFile == "index.md.tmpl" {
 				tmpl := providerTemplate(tmplData)
-				exampleFilePath := filepath.Join(g.examplesDir, "provider", "provider.tf")
-				render, err := tmpl.Render(providerName, g.renderedProviderName, exampleFilePath, providerSchema.ConfigSchema)
+				exampleFilePath := filepath.Join(g.ProviderExamplesDir(), "provider", "provider.tf")
+				render, err := tmpl.Render(g.providerDir, providerName, g.renderedProviderName, exampleFilePath, providerSchema.ConfigSchema)
 				if err != nil {
 					return fmt.Errorf("unable to render provider template %q: %w", rel, err)
 				}
@@ -473,7 +523,7 @@ func (g *generator) renderStaticWebsite(providerName string, providerSchema *tfj
 		}
 
 		tmpl := docTemplate(tmplData)
-		err = tmpl.Render(out)
+		err = tmpl.Render(g.providerDir, out)
 		if err != nil {
 			return fmt.Errorf("unable to render template %q: %w", rel, err)
 		}
@@ -510,6 +560,7 @@ func (g *generator) terraformProviderSchema(ctx context.Context, providerName st
 		outFile = outFile + ".exe"
 	}
 	buildCmd := exec.Command("go", "build", "-o", outFile)
+	buildCmd.Dir = g.providerDir
 	// TODO: constrain env here to make it a little safer?
 	_, err = runCmd(buildCmd)
 	if err != nil {

vendor/github.com/hashicorp/terraform-plugin-docs/internal/provider/template.go

@@ -1,9 +1,13 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package provider
 
 import (
 	"bytes"
 	"fmt"
 	"io"
+	"path/filepath"
 	"strings"
 	"text/template"
 
@@ -32,17 +36,17 @@ type (
 	docTemplate string
 )
 
-func newTemplate(name, text string) (*template.Template, error) {
+func newTemplate(providerDir, name, text string) (*template.Template, error) {
 	tmpl := template.New(name)
 	titleCaser := cases.Title(language.Und)
 
 	tmpl.Funcs(map[string]interface{}{
-		"codefile":      tmplfuncs.CodeFile,
+		"codefile":      codeFile(providerDir),
 		"lower":         strings.ToLower,
 		"plainmarkdown": mdplain.PlainMarkdown,
 		"prefixlines":   tmplfuncs.PrefixLines,
 		"split":         strings.Split,
-		"tffile":        terraformCodeFile,
+		"tffile":        terraformCodeFile(providerDir),
 		"title":         titleCaser.String,
 		"trimspace":     strings.TrimSpace,
 		"upper":         strings.ToUpper,
@@ -57,13 +61,29 @@ func newTemplate(name, text string) (*template.Template, error) {
 	return tmpl, nil
 }
 
-func terraformCodeFile(file string) (string, error) {
+func codeFile(providerDir string) func(string, string) (string, error) {
+	return func(format string, file string) (string, error) {
+		if filepath.IsAbs(file) {
+			return tmplfuncs.CodeFile(format, file)
+		}
+
+		return tmplfuncs.CodeFile(format, filepath.Join(providerDir, file))
+	}
+}
+
+func terraformCodeFile(providerDir string) func(string) (string, error) {
 	// TODO: omit comment handling
+	return func(file string) (string, error) {
+		if filepath.IsAbs(file) {
 			return tmplfuncs.CodeFile("terraform", file)
 		}
 
-func renderTemplate(name string, text string, out io.Writer, data interface{}) error {
-	tmpl, err := newTemplate(name, text)
+		return tmplfuncs.CodeFile("terraform", filepath.Join(providerDir, file))
+	}
+}
+
+func renderTemplate(providerDir, name string, text string, out io.Writer, data interface{}) error {
+	tmpl, err := newTemplate(providerDir, name, text)
 	if err != nil {
 		return err
 	}
@@ -76,10 +96,10 @@ func renderTemplate(name string, text string, out io.Writer, data interface{}) e
 	return nil
 }
 
-func renderStringTemplate(name, text string, data interface{}) (string, error) {
+func renderStringTemplate(providerDir, name, text string, data interface{}) (string, error) {
 	var buf bytes.Buffer
 
-	err := renderTemplate(name, text, &buf, data)
+	err := renderTemplate(providerDir, name, text, &buf, data)
 	if err != nil {
 		return "", err
 	}
@@ -87,21 +107,21 @@ func renderStringTemplate(name, text string, data interface{}) (string, error) {
 	return buf.String(), nil
 }
 
-func (t docTemplate) Render(out io.Writer) error {
+func (t docTemplate) Render(providerDir string, out io.Writer) error {
 	s := string(t)
 	if s == "" {
 		return nil
 	}
 
-	return renderTemplate("docTemplate", s, out, nil)
+	return renderTemplate(providerDir, "docTemplate", s, out, nil)
 }
 
-func (t resourceFileTemplate) Render(name, providerName string) (string, error) {
+func (t resourceFileTemplate) Render(providerDir, name, providerName string) (string, error) {
 	s := string(t)
 	if s == "" {
 		return "", nil
 	}
-	return renderStringTemplate("resourceFileTemplate", s, struct {
+	return renderStringTemplate(providerDir, "resourceFileTemplate", s, struct {
 		Name      string
 		ShortName string
 
@@ -116,18 +136,18 @@ func (t resourceFileTemplate) Render(name, providerName string) (string, error)
 	})
 }
 
-func (t providerFileTemplate) Render(name string) (string, error) {
+func (t providerFileTemplate) Render(providerDir, name string) (string, error) {
 	s := string(t)
 	if s == "" {
 		return "", nil
 	}
-	return renderStringTemplate("providerFileTemplate", s, struct {
+	return renderStringTemplate(providerDir, "providerFileTemplate", s, struct {
 		Name      string
 		ShortName string
 	}{name, providerShortName(name)})
 }
 
-func (t providerTemplate) Render(providerName, renderedProviderName, exampleFile string, schema *tfjson.Schema) (string, error) {
+func (t providerTemplate) Render(providerDir, providerName, renderedProviderName, exampleFile string, schema *tfjson.Schema) (string, error) {
 	schemaBuffer := bytes.NewBuffer(nil)
 	err := schemamd.Render(schema, schemaBuffer)
 	if err != nil {
@@ -138,7 +158,8 @@ func (t providerTemplate) Render(providerName, renderedProviderName, exampleFile
 	if s == "" {
 		return "", nil
 	}
-	return renderStringTemplate("providerTemplate", s, struct {
+
+	return renderStringTemplate(providerDir, "providerTemplate", s, struct {
 		Description string
 
 		HasExample  bool
@@ -165,7 +186,7 @@ func (t providerTemplate) Render(providerName, renderedProviderName, exampleFile
 	})
 }
 
-func (t resourceTemplate) Render(name, providerName, renderedProviderName, typeName, exampleFile, importFile string, schema *tfjson.Schema) (string, error) {
+func (t resourceTemplate) Render(providerDir, name, providerName, renderedProviderName, typeName, exampleFile, importFile string, schema *tfjson.Schema) (string, error) {
 	schemaBuffer := bytes.NewBuffer(nil)
 	err := schemamd.Render(schema, schemaBuffer)
 	if err != nil {
@@ -177,7 +198,7 @@ func (t resourceTemplate) Render(name, providerName, renderedProviderName, typeN
 		return "", nil
 	}
 
-	return renderStringTemplate("resourceTemplate", s, struct {
+	return renderStringTemplate(providerDir, "resourceTemplate", s, struct {
 		Type        string
 		Name        string
 		Description string
@@ -233,8 +254,8 @@ description: |-
 {{- end }}
 
 {{ .SchemaMarkdown | trimspace }}
+{{- if .HasImport }}
 
-{{ if .HasImport -}}
 ## Import
 
 Import is supported using the following syntax:

vendor/github.com/hashicorp/terraform-plugin-docs/internal/provider/util.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package provider
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/internal/provider/validate.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package provider
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/internal/tmplfuncs/tmplfuncs.go

@@ -1,9 +1,11 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package tmplfuncs
 
 import (
 	"fmt"
 	"os"
-	"path/filepath"
 	"strings"
 )
 
@@ -12,15 +14,7 @@ func PrefixLines(prefix, text string) string {
 }
 
 func CodeFile(format, file string) (string, error) {
-	// paths are relative to the rendering process work dir, which
-	// may be undesirable, probably need to think about it
-	wd, err := os.Getwd()
-	if err != nil {
-		return "", err
-	}
-
-	fullPath := filepath.Join(wd, file)
-	content, err := os.ReadFile(fullPath)
+	content, err := os.ReadFile(file)
 	if err != nil {
 		return "", fmt.Errorf("unable to read content from %q: %w", file, err)
 	}

vendor/github.com/hashicorp/terraform-plugin-docs/schemamd/behaviors.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package schemamd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/schemamd/render.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package schemamd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/schemamd/write_attribute_description.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package schemamd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/schemamd/write_block_type_description.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package schemamd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/schemamd/write_nested_attribute_type_description.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package schemamd
 
 import (

vendor/github.com/hashicorp/terraform-plugin-docs/schemamd/write_type.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package schemamd
 
 import (

vendor/modules.txt

@@ -142,8 +142,8 @@ github.com/hashicorp/terraform-exec/tfexec
 # github.com/hashicorp/terraform-json v0.17.0
 ## explicit; go 1.18
 github.com/hashicorp/terraform-json
-# github.com/hashicorp/terraform-plugin-docs v0.14.1
-## explicit; go 1.18
+# github.com/hashicorp/terraform-plugin-docs v0.15.0
+## explicit; go 1.19
 github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
 github.com/hashicorp/terraform-plugin-docs/internal/cmd
 github.com/hashicorp/terraform-plugin-docs/internal/mdplain