Skip to content

Commit

Permalink
Move schemamd and functionmd packages to internal (#354)
Browse files Browse the repository at this point in the history
* Move `schemamd` and `functionmd` packages to `internal`

* Add changelog entries

* Switch changelog entry kind to `Breaking Changes`
  • Loading branch information
SBGoods authored Apr 11, 2024
1 parent ab779d3 commit 1f28b7c
Show file tree
Hide file tree
Showing 29 changed files with 25 additions and 9 deletions.
6 changes: 6 additions & 0 deletions .changes/unreleased/BREAKING CHANGES-20240410-161445.yaml
Original file line number Diff line number Diff line change
@@ -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"
6 changes: 6 additions & 0 deletions .changes/unreleased/BREAKING CHANGES-20240410-161540.yaml
Original file line number Diff line number Diff line change
@@ -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"
2 changes: 1 addition & 1 deletion functionmd/render.go → internal/functionmd/render.go
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
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 3 additions & 2 deletions internal/provider/template.go
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 2 additions & 1 deletion schemamd/render_test.go → internal/schemamd/render_test.go
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
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
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
File renamed without changes.
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

0 comments on commit 1f28b7c

Please sign in to comment.