Move schemamd and functionmd packages to internal (#354)

* Move `schemamd` and `functionmd` packages to `internal` * Add changelog entries * Switch changelog entry kind to `Breaking Changes`
hashicorp · Apr 11, 2024 · 1f28b7c · 1f28b7c
1 parent ab779d3
commit 1f28b7c
Show file tree

Hide file tree

Showing 29 changed files with 25 additions and 9 deletions.
diff --git a/.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml b/.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml
@@ -0,0 +1,6 @@
+kind: BREAKING CHANGES
+body: 'schemamd: The `schemamd` package has moved to `internal/schemamd` and can no
+  longer be imported'
+time: 2024-04-10T16:14:45.685307-04:00
+custom:
+  Issue: "354"
diff --git a/.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml b/.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml
@@ -0,0 +1,6 @@
+kind: BREAKING CHANGES
+body: 'functionmd: The `functionmd` package has moved to `internal/functionmd` and
+  can no longer be imported'
+time: 2024-04-10T16:15:40.388578-04:00
+custom:
+  Issue: "354"
diff --git a/functionmd/render.go → internal/functionmd/render.go b/functionmd/render.go → internal/functionmd/render.go
@@ -10,7 +10,7 @@ import (
 
 	tfjson "github.com/hashicorp/terraform-json"
 
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 // RenderArguments returns a Markdown formatted string of the function arguments.

diff --git a/functionmd/render_test.go → internal/functionmd/render_test.go b/functionmd/render_test.go → internal/functionmd/render_test.go
@@ -12,7 +12,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
 
-	"github.com/hashicorp/terraform-plugin-docs/functionmd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/functionmd"
 )
 
 func TestRenderArguments(t *testing.T) {

diff --git a/functionmd/testdata/example_arguments.md → .../functionmd/testdata/example_arguments.md b/functionmd/testdata/example_arguments.md → .../functionmd/testdata/example_arguments.md
diff --git a/functionmd/testdata/example_signature.md → .../functionmd/testdata/example_signature.md b/functionmd/testdata/example_signature.md → .../functionmd/testdata/example_signature.md
diff --git a/functionmd/testdata/example_vararg.md → ...nal/functionmd/testdata/example_vararg.md b/functionmd/testdata/example_vararg.md → ...nal/functionmd/testdata/example_vararg.md
diff --git a/...d/testdata/function_signature.schema.json → ...d/testdata/function_signature.schema.json b/...d/testdata/function_signature.schema.json → ...d/testdata/function_signature.schema.json
diff --git a/internal/provider/template.go b/internal/provider/template.go
@@ -16,10 +16,11 @@ import (
 
 	tfjson "github.com/hashicorp/terraform-json"
 
-	"github.com/hashicorp/terraform-plugin-docs/functionmd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/functionmd"
 	"github.com/hashicorp/terraform-plugin-docs/internal/mdplain"
 	"github.com/hashicorp/terraform-plugin-docs/internal/tmplfuncs"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
 )
 
 const (

diff --git a/schemamd/behaviors.go → internal/schemamd/behaviors.go b/schemamd/behaviors.go → internal/schemamd/behaviors.go
diff --git a/schemamd/behaviors_test.go → internal/schemamd/behaviors_test.go b/schemamd/behaviors_test.go → internal/schemamd/behaviors_test.go
diff --git a/schemamd/render.go → internal/schemamd/render.go b/schemamd/render.go → internal/schemamd/render.go
diff --git a/schemamd/render_test.go → internal/schemamd/render_test.go b/schemamd/render_test.go → internal/schemamd/render_test.go
@@ -11,7 +11,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestRender(t *testing.T) {

diff --git a/schemamd/testdata/aws_acm_certificate.md → .../schemamd/testdata/aws_acm_certificate.md b/schemamd/testdata/aws_acm_certificate.md → .../schemamd/testdata/aws_acm_certificate.md
diff --git a/.../testdata/aws_acm_certificate.schema.json → .../testdata/aws_acm_certificate.schema.json b/.../testdata/aws_acm_certificate.schema.json → .../testdata/aws_acm_certificate.schema.json
diff --git a/...d/testdata/aws_route_table_association.md → ...d/testdata/aws_route_table_association.md b/...d/testdata/aws_route_table_association.md → ...d/testdata/aws_route_table_association.md
diff --git a/...a/aws_route_table_association.schema.json → ...a/aws_route_table_association.schema.json b/...a/aws_route_table_association.schema.json → ...a/aws_route_table_association.schema.json
diff --git a/...mamd/testdata/awscc_acmpca_certificate.md → ...mamd/testdata/awscc_acmpca_certificate.md b/...mamd/testdata/awscc_acmpca_certificate.md → ...mamd/testdata/awscc_acmpca_certificate.md
diff --git a/...data/awscc_acmpca_certificate.schema.json → ...data/awscc_acmpca_certificate.schema.json b/...data/awscc_acmpca_certificate.schema.json → ...data/awscc_acmpca_certificate.schema.json
diff --git a/schemamd/testdata/awscc_logs_log_group.md → ...schemamd/testdata/awscc_logs_log_group.md b/schemamd/testdata/awscc_logs_log_group.md → ...schemamd/testdata/awscc_logs_log_group.md
diff --git a/...testdata/awscc_logs_log_group.schema.json → ...testdata/awscc_logs_log_group.schema.json b/...testdata/awscc_logs_log_group.schema.json → ...testdata/awscc_logs_log_group.schema.json
diff --git a/schemamd/write_attribute_description.go → ...l/schemamd/write_attribute_description.go b/schemamd/write_attribute_description.go → ...l/schemamd/write_attribute_description.go
diff --git a/schemamd/write_attribute_description_test.go → ...emamd/write_attribute_description_test.go b/schemamd/write_attribute_description_test.go → ...emamd/write_attribute_description_test.go
@@ -11,7 +11,7 @@ import (
 	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/zclconf/go-cty/cty"
 
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteAttributeDescription(t *testing.T) {

diff --git a/schemamd/write_block_type_description.go → .../schemamd/write_block_type_description.go b/schemamd/write_block_type_description.go → .../schemamd/write_block_type_description.go
diff --git a/...mamd/write_block_type_description_test.go → ...mamd/write_block_type_description_test.go b/...mamd/write_block_type_description_test.go → ...mamd/write_block_type_description_test.go
@@ -9,7 +9,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteBlockTypeDescription(t *testing.T) {

diff --git a/...rite_nested_attribute_type_description.go → ...rite_nested_attribute_type_description.go b/...rite_nested_attribute_type_description.go → ...rite_nested_attribute_type_description.go
diff --git a/...nested_attribute_type_description_test.go → ...nested_attribute_type_description_test.go b/...nested_attribute_type_description_test.go → ...nested_attribute_type_description_test.go
@@ -9,8 +9,9 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	tfjson "github.com/hashicorp/terraform-json"
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
 	"github.com/zclconf/go-cty/cty"
+
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteNestedAttributeTypeDescription(t *testing.T) {

diff --git a/schemamd/write_type.go → internal/schemamd/write_type.go b/schemamd/write_type.go → internal/schemamd/write_type.go
diff --git a/schemamd/write_type_test.go → internal/schemamd/write_type_test.go b/schemamd/write_type_test.go → internal/schemamd/write_type_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/zclconf/go-cty/cty"
 
-	"github.com/hashicorp/terraform-plugin-docs/schemamd"
+	"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
 )
 
 func TestWriteType(t *testing.T) {