From ade0cc92013cc7bcfeb5677bf153f927e88bca49 Mon Sep 17 00:00:00 2001 From: Jacob Bednarz Date: Mon, 12 Sep 2022 10:08:57 +1000 Subject: [PATCH 1/4] validate: allow `resources.md.tmpl` and `data-sources.md.tmpl` to pass validation Closes #182 --- internal/provider/validate.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/internal/provider/validate.go b/internal/provider/validate.go index 5bc53656..58180107 100644 --- a/internal/provider/validate.go +++ b/internal/provider/validate.go @@ -55,6 +55,10 @@ func validateTemplates(ui cli.Ui, dir string) error { checkAllowedFiles( "index.md", "index.md.tmpl", + "resources.md", + "resources.md.tmpl", + "data-sources.md", + "data-sources.md.tmpl", ), checkAllowedDirs( "data-sources", From 27131190046e1633e7b833ef2918fbfaa3226731 Mon Sep 17 00:00:00 2001 From: Jacob Bednarz Date: Mon, 12 Sep 2022 10:09:22 +1000 Subject: [PATCH 2/4] validate: provide feedback when validation finishes --- internal/provider/validate.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/internal/provider/validate.go b/internal/provider/validate.go index 58180107..550350c1 100644 --- a/internal/provider/validate.go +++ b/internal/provider/validate.go @@ -43,6 +43,8 @@ func Validate(ui cli.Ui) error { return validateLegacyWebsite(ui, "website") } + ui.Info("validation checks complete, no issues detected!") + return nil } From 927f541aa8fc4bc94e14bfd2f198a07bf7877130 Mon Sep 17 00:00:00 2001 From: Jacob Bednarz Date: Mon, 12 Sep 2022 10:09:52 +1000 Subject: [PATCH 3/4] remove rogue `return `err` that causes validation to exit --- internal/provider/validate.go | 1 - 1 file changed, 1 deletion(-) diff --git a/internal/provider/validate.go b/internal/provider/validate.go index 550350c1..1dc5437c 100644 --- a/internal/provider/validate.go +++ b/internal/provider/validate.go @@ -34,7 +34,6 @@ func Validate(ui cli.Ui) error { return err } } - return err case dirExists("docs"): ui.Info("detected static docs directory, running checks") return validateStaticDocs(ui, "docs") From 9d91573fc553b21550be7ddbc9896249d504d320 Mon Sep 17 00:00:00 2001 From: Jacob Bednarz Date: Mon, 12 Sep 2022 10:13:51 +1000 Subject: [PATCH 4/4] add CHANGELOG --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index eb34bdf9..f9f7021b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# 0.14.0 (Unreleased) + +BUG FIXES: + +* cmd/validate: allow top level templates (`resources.md.tmpl` and `data-sources.md.tmpl`) to pass validation ([#184](https://github.com/hashicorp/terraform-plugin-docs/pull/184)). + # 0.13.0 (July 8, 2022) ENHANCEMENTS: