Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move schemamd and functionmd packages to internal #354

Merged
merged 3 commits into from
Apr 11, 2024
Merged

Move schemamd and functionmd packages to internal #354

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0644e9e
Move `schemamd` and `functionmd` packages to `internal`
SBGoods Apr 10, 2024
7b89b29
Add changelog entries
SBGoods Apr 10, 2024
ff70987
Switch changelog entry kind to `Breaking Changes`
SBGoods Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/unreleased/NOTES-20240410-161445.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: NOTES
SBGoods marked this conversation as resolved.
Show resolved Hide resolved
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"
6 changes: 6 additions & 0 deletions .changes/unreleased/NOTES-20240410-161540.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: NOTES
SBGoods marked this conversation as resolved.
Show resolved Hide resolved
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"
2 changes: 1 addition & 1 deletion functionmd/render.go → internal/functionmd/render.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion functionmd/render_test.go → internal/functionmd/render_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
0 functionmd/testdata/example_arguments.md → .../functionmd/testdata/example_arguments.md
View file
Open in desktop
File renamed without changes.
0 functionmd/testdata/example_signature.md → .../functionmd/testdata/example_signature.md
View file
Open in desktop
File renamed without changes.
0 functionmd/testdata/example_vararg.md → ...nal/functionmd/testdata/example_vararg.md
View file
Open in desktop
File renamed without changes.
0 ...d/testdata/function_signature.schema.json → ...d/testdata/function_signature.schema.json
View file
Open in desktop
File renamed without changes.
5 changes: 3 additions & 2 deletions internal/provider/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
0 schemamd/behaviors.go → internal/schemamd/behaviors.go
View file
Open in desktop
File renamed without changes.
0 schemamd/behaviors_test.go → internal/schemamd/behaviors_test.go
View file
Open in desktop
File renamed without changes.
0 schemamd/render.go → internal/schemamd/render.go
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion schemamd/render_test.go → internal/schemamd/render_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
0 schemamd/testdata/aws_acm_certificate.md → .../schemamd/testdata/aws_acm_certificate.md
View file
Open in desktop
File renamed without changes.
0 .../testdata/aws_acm_certificate.schema.json → .../testdata/aws_acm_certificate.schema.json
View file
Open in desktop
File renamed without changes.
0 ...d/testdata/aws_route_table_association.md → ...d/testdata/aws_route_table_association.md
View file
Open in desktop
File renamed without changes.
0 ...a/aws_route_table_association.schema.json → ...a/aws_route_table_association.schema.json
View file
Open in desktop
File renamed without changes.
0 ...mamd/testdata/awscc_acmpca_certificate.md → ...mamd/testdata/awscc_acmpca_certificate.md
View file
Open in desktop
File renamed without changes.
0 ...data/awscc_acmpca_certificate.schema.json → ...data/awscc_acmpca_certificate.schema.json
View file
Open in desktop
File renamed without changes.
0 schemamd/testdata/awscc_logs_log_group.md → ...schemamd/testdata/awscc_logs_log_group.md
View file
Open in desktop
File renamed without changes.
0 ...testdata/awscc_logs_log_group.schema.json → ...testdata/awscc_logs_log_group.schema.json
View file
Open in desktop
File renamed without changes.
0 schemamd/write_attribute_description.go → ...l/schemamd/write_attribute_description.go
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion schemamd/write_attribute_description_test.go → ...emamd/write_attribute_description_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
0 schemamd/write_block_type_description.go → .../schemamd/write_block_type_description.go
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion ...mamd/write_block_type_description_test.go → ...mamd/write_block_type_description_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
0 ...rite_nested_attribute_type_description.go → ...rite_nested_attribute_type_description.go
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion ...nested_attribute_type_description_test.go → ...nested_attribute_type_description_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
0 schemamd/write_type.go → internal/schemamd/write_type.go
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion schemamd/write_type_test.go → internal/schemamd/write_type_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down