From 52bedadd59b1b93fa110f042cd2bfd901ea4fb81 Mon Sep 17 00:00:00 2001 From: Joachim Desroches Date: Thu, 6 Feb 2025 15:33:40 +0100 Subject: [PATCH 1/3] Remove subcategory field from frontmatter in default provider template. --- internal/provider/template.go | 1 - 1 file changed, 1 deletion(-) diff --git a/internal/provider/template.go b/internal/provider/template.go index 58766489..9a965fc8 100644 --- a/internal/provider/template.go +++ b/internal/provider/template.go @@ -331,7 +331,6 @@ description: |- const defaultProviderTemplate providerTemplate = `--- ` + frontmatterComment + ` page_title: "{{.ProviderShortName}} Provider" -subcategory: "" description: |- {{ .Description | plainmarkdown | trimspace | prefixlines " " }} --- From b456bad3f92d9ab3bb10a7d5b640e807f1eda6ee Mon Sep 17 00:00:00 2001 From: Selena Goods Date: Fri, 13 Jun 2025 15:27:36 -0400 Subject: [PATCH 2/3] Fix failing tests --- .../generate/framework_provider_success_no_templates.txtar | 1 - .../framework_provider_success_all_framework_types.txtar | 1 - .../generate/framework_provider_success_no_templates.txtar | 1 - .../scripts/schema-json/generate/nested_id_attribute.txtar | 1 - 4 files changed, 4 deletions(-) diff --git a/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar b/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar index bb6e91cc..94f1c263 100644 --- a/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar +++ b/cmd/tfplugindocs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar @@ -68,7 +68,6 @@ data "scaffolding_example" "example" { --- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "scaffolding Provider" -subcategory: "" description: |- Example provider --- diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar index 813b5c6f..8aba3640 100644 --- a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar +++ b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar @@ -32,7 +32,6 @@ rendering "resources/example.md.tmpl" --- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "scaffolding Provider" -subcategory: "" description: |- Example provider --- diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar index 861b396e..7710fdfb 100644 --- a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar +++ b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_no_templates.txtar @@ -103,7 +103,6 @@ example(input string, variadicInput string...) string --- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "scaffolding Provider" -subcategory: "" description: |- Example provider --- diff --git a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/nested_id_attribute.txtar b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/nested_id_attribute.txtar index 21628fae..886c20aa 100644 --- a/cmd/tfplugindocs/testdata/scripts/schema-json/generate/nested_id_attribute.txtar +++ b/cmd/tfplugindocs/testdata/scripts/schema-json/generate/nested_id_attribute.txtar @@ -29,7 +29,6 @@ rendering "resources/example.md.tmpl" --- # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "scaffolding Provider" -subcategory: "" description: |- Example provider --- From 7e3cd9a5551231bc09e340f495d307bb21891b1e Mon Sep 17 00:00:00 2001 From: Selena Goods Date: Fri, 13 Jun 2025 15:29:15 -0400 Subject: [PATCH 3/3] Add changelog entry --- .changes/unreleased/BUG FIXES-20250613-152846.yaml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changes/unreleased/BUG FIXES-20250613-152846.yaml diff --git a/.changes/unreleased/BUG FIXES-20250613-152846.yaml b/.changes/unreleased/BUG FIXES-20250613-152846.yaml new file mode 100644 index 00000000..ab5359dd --- /dev/null +++ b/.changes/unreleased/BUG FIXES-20250613-152846.yaml @@ -0,0 +1,5 @@ +kind: BUG FIXES +body: 'generate: Remove `subcategory` field from default provider templates' +time: 2025-06-13T15:28:46.039473-04:00 +custom: + Issue: "446"