Skip to content

Commit 1f28b7c

Browse files
SBGoodsSBGoods
authored
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`
1 parent ab779d3 commit 1f28b7c

29 files changed

+25
-9
lines changed

‎.changes/unreleased/BREAKING CHANGES-20240410-161445.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
kind: BREAKING CHANGES
2+
body: 'schemamd: The `schemamd` package has moved to `internal/schemamd` and can no
3+
longer be imported'
4+
time: 2024-04-10T16:14:45.685307-04:00
5+
custom:
6+
Issue: "354"

‎.changes/unreleased/BREAKING CHANGES-20240410-161540.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
kind: BREAKING CHANGES
2+
body: 'functionmd: The `functionmd` package has moved to `internal/functionmd` and
3+
can no longer be imported'
4+
time: 2024-04-10T16:15:40.388578-04:00
5+
custom:
6+
Issue: "354"

‎functionmd/render.go renamed to ‎internal/functionmd/render.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010

1111
tfjson "github.com/hashicorp/terraform-json"
1212

13-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
13+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
1414
)
1515

1616
// RenderArguments returns a Markdown formatted string of the function arguments.

‎functionmd/render_test.go renamed to ‎internal/functionmd/render_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
"github.com/google/go-cmp/cmp"
1313
tfjson "github.com/hashicorp/terraform-json"
1414

15-
"github.com/hashicorp/terraform-plugin-docs/functionmd"
15+
"github.com/hashicorp/terraform-plugin-docs/internal/functionmd"
1616
)
1717

1818
func TestRenderArguments(t *testing.T) {

‎functionmd/testdata/example_arguments.md renamed to ‎internal/functionmd/testdata/example_arguments.md

File renamed without changes.

‎functionmd/testdata/example_signature.md renamed to ‎internal/functionmd/testdata/example_signature.md

File renamed without changes.

‎functionmd/testdata/example_vararg.md renamed to ‎internal/functionmd/testdata/example_vararg.md

File renamed without changes.

‎functionmd/testdata/function_signature.schema.json renamed to ‎internal/functionmd/testdata/function_signature.schema.json

File renamed without changes.

‎internal/provider/template.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ import (
1616

1717
tfjson "github.com/hashicorp/terraform-json"
1818

19-
"github.com/hashicorp/terraform-plugin-docs/functionmd"
19+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
20+
21+
"github.com/hashicorp/terraform-plugin-docs/internal/functionmd"
2022
"github.com/hashicorp/terraform-plugin-docs/internal/mdplain"
2123
"github.com/hashicorp/terraform-plugin-docs/internal/tmplfuncs"
22-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
2324
)
2425

2526
const (

‎schemamd/behaviors.go renamed to ‎internal/schemamd/behaviors.go

File renamed without changes.

‎schemamd/behaviors_test.go renamed to ‎internal/schemamd/behaviors_test.go

File renamed without changes.

‎schemamd/render.go renamed to ‎internal/schemamd/render.go

File renamed without changes.

‎schemamd/render_test.go renamed to ‎internal/schemamd/render_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ import (
1111

1212
"github.com/google/go-cmp/cmp"
1313
tfjson "github.com/hashicorp/terraform-json"
14-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
14+
15+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
1516
)
1617

1718
func TestRender(t *testing.T) {

‎schemamd/testdata/aws_acm_certificate.md renamed to ‎internal/schemamd/testdata/aws_acm_certificate.md

File renamed without changes.

‎schemamd/testdata/aws_acm_certificate.schema.json renamed to ‎internal/schemamd/testdata/aws_acm_certificate.schema.json

File renamed without changes.

‎schemamd/testdata/aws_route_table_association.md renamed to ‎internal/schemamd/testdata/aws_route_table_association.md

File renamed without changes.

‎schemamd/testdata/aws_route_table_association.schema.json renamed to ‎internal/schemamd/testdata/aws_route_table_association.schema.json

File renamed without changes.

‎schemamd/testdata/awscc_acmpca_certificate.md renamed to ‎internal/schemamd/testdata/awscc_acmpca_certificate.md

File renamed without changes.

‎schemamd/testdata/awscc_acmpca_certificate.schema.json renamed to ‎internal/schemamd/testdata/awscc_acmpca_certificate.schema.json

File renamed without changes.

‎schemamd/testdata/awscc_logs_log_group.md renamed to ‎internal/schemamd/testdata/awscc_logs_log_group.md

File renamed without changes.

‎schemamd/testdata/awscc_logs_log_group.schema.json renamed to ‎internal/schemamd/testdata/awscc_logs_log_group.schema.json

File renamed without changes.

‎schemamd/write_attribute_description.go renamed to ‎internal/schemamd/write_attribute_description.go

File renamed without changes.

‎schemamd/write_attribute_description_test.go renamed to ‎internal/schemamd/write_attribute_description_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
tfjson "github.com/hashicorp/terraform-json"
1212
"github.com/zclconf/go-cty/cty"
1313

14-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
14+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
1515
)
1616

1717
func TestWriteAttributeDescription(t *testing.T) {

‎schemamd/write_block_type_description.go renamed to ‎internal/schemamd/write_block_type_description.go

File renamed without changes.

‎schemamd/write_block_type_description_test.go renamed to ‎internal/schemamd/write_block_type_description_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ import (
99

1010
"github.com/google/go-cmp/cmp"
1111
tfjson "github.com/hashicorp/terraform-json"
12-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
12+
13+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
1314
)
1415

1516
func TestWriteBlockTypeDescription(t *testing.T) {

‎schemamd/write_nested_attribute_type_description.go renamed to ‎internal/schemamd/write_nested_attribute_type_description.go

File renamed without changes.

‎schemamd/write_nested_attribute_type_description_test.go renamed to ‎internal/schemamd/write_nested_attribute_type_description_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ import (
99

1010
"github.com/google/go-cmp/cmp"
1111
tfjson "github.com/hashicorp/terraform-json"
12-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
1312
"github.com/zclconf/go-cty/cty"
13+
14+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
1415
)
1516

1617
func TestWriteNestedAttributeTypeDescription(t *testing.T) {

‎schemamd/write_type.go renamed to ‎internal/schemamd/write_type.go

File renamed without changes.

‎schemamd/write_type_test.go renamed to ‎internal/schemamd/write_type_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"github.com/google/go-cmp/cmp"
1212
"github.com/zclconf/go-cty/cty"
1313

14-
"github.com/hashicorp/terraform-plugin-docs/schemamd"
14+
"github.com/hashicorp/terraform-plugin-docs/internal/schemamd"
1515
)
1616

1717
func TestWriteType(t *testing.T) {

0 commit comments

Comments
 (0)