From 7d0578c5b790d2b89489d2096b3dd733798adebe Mon Sep 17 00:00:00 2001 From: Sylvia Moss Date: Fri, 22 Jan 2021 17:55:32 +0100 Subject: [PATCH] add DatasourceOutput type to struct-markdown cmd (#10512) --- cmd/struct-markdown/main.go | 13 ++++++++++++- website/content/docs/datasources/amazon/ami.mdx | 2 +- .../docs/datasources/amazon/secretsmanager.mdx | 2 +- ...Output-not-required.mdx => DatasourceOutput.mdx} | 0 ...Output-not-required.mdx => DatasourceOutput.mdx} | 0 5 files changed, 14 insertions(+), 3 deletions(-) rename website/content/partials/datasource/amazon/ami/{DatasourceOutput-not-required.mdx => DatasourceOutput.mdx} (100%) rename website/content/partials/datasource/amazon/secretsmanager/{DatasourceOutput-not-required.mdx => DatasourceOutput.mdx} (100%) diff --git a/cmd/struct-markdown/main.go b/cmd/struct-markdown/main.go index ed3e58392..9a6394630 100644 --- a/cmd/struct-markdown/main.go +++ b/cmd/struct-markdown/main.go @@ -75,6 +75,11 @@ func main() { Filename: typeSpec.Name.Name + ".mdx", Header: strings.TrimSpace(typeDecl.Doc.Text()), } + dataSourceOutput := Struct{ + SourcePath: sourcePath, + Name: typeSpec.Name.Name, + Filename: typeSpec.Name.Name + ".mdx", + } required := Struct{ SourcePath: sourcePath, Name: typeSpec.Name.Name, @@ -145,6 +150,12 @@ func main() { Type: fieldType, Docs: docs, } + + if typeSpec.Name.Name == "DatasourceOutput" { + dataSourceOutput.Fields = append(dataSourceOutput.Fields, field) + continue + } + if req, err := tags.Get("required"); err == nil && req.Value() == "true" { required.Fields = append(required.Fields, field) } else { @@ -155,7 +166,7 @@ func main() { dir := filepath.Join(projectRoot, "website", "content", "partials", builderName) os.MkdirAll(dir, 0755) - for _, str := range []Struct{header, required, notRequired} { + for _, str := range []Struct{header, dataSourceOutput, required, notRequired} { if len(str.Fields) == 0 && len(str.Header) == 0 { continue } diff --git a/website/content/docs/datasources/amazon/ami.mdx b/website/content/docs/datasources/amazon/ami.mdx index 0053dda5e..b8b1a2a63 100644 --- a/website/content/docs/datasources/amazon/ami.mdx +++ b/website/content/docs/datasources/amazon/ami.mdx @@ -38,4 +38,4 @@ This selects the most recent Ubuntu 16.04 HVM EBS AMI from Canonical. Note that ## Output Data -@include 'datasource/amazon/ami/DatasourceOutput-not-required.mdx' +@include 'datasource/amazon/ami/DatasourceOutput.mdx' diff --git a/website/content/docs/datasources/amazon/secretsmanager.mdx b/website/content/docs/datasources/amazon/secretsmanager.mdx index 625493bcd..352cf8306 100644 --- a/website/content/docs/datasources/amazon/secretsmanager.mdx +++ b/website/content/docs/datasources/amazon/secretsmanager.mdx @@ -48,4 +48,4 @@ with the [jsondecode() function](/docs/templates/hcl_templates/functions/encodin ## Output Data -@include 'datasource/amazon/secretsmanager/DatasourceOutput-not-required.mdx' +@include 'datasource/amazon/secretsmanager/DatasourceOutput.mdx' diff --git a/website/content/partials/datasource/amazon/ami/DatasourceOutput-not-required.mdx b/website/content/partials/datasource/amazon/ami/DatasourceOutput.mdx similarity index 100% rename from website/content/partials/datasource/amazon/ami/DatasourceOutput-not-required.mdx rename to website/content/partials/datasource/amazon/ami/DatasourceOutput.mdx diff --git a/website/content/partials/datasource/amazon/secretsmanager/DatasourceOutput-not-required.mdx b/website/content/partials/datasource/amazon/secretsmanager/DatasourceOutput.mdx similarity index 100% rename from website/content/partials/datasource/amazon/secretsmanager/DatasourceOutput-not-required.mdx rename to website/content/partials/datasource/amazon/secretsmanager/DatasourceOutput.mdx