Skip to content

Commit 8eb3d7f

Browse files
authored
actions: Remove unlinked references and update terraform-json (#523)
1 parent 8eeb48b commit 8eb3d7f

24 files changed

+191
-205
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
kind: FEATURES
2-
body: 'generate: Add support for unlinked actions'
2+
body: 'generate: Add support for actions'
33
time: 2025-08-11T17:41:12.858383-04:00
44
custom:
55
Issue: "505"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
kind: FEATURES
2-
body: 'migrate: Add support for unlinked actions'
2+
body: 'migrate: Add support for actions'
33
time: 2025-08-11T17:41:41.553344-04:00
44
custom:
55
Issue: "505"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
kind: FEATURES
2-
body: 'validate: Add support for unlinked actions'
2+
body: 'validate: Add support for actions'
33
time: 2025-08-11T17:41:55.966547-04:00
44
custom:
55
Issue: "505"

cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_generic_templates.txtar

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ cmpenv docs/data-sources/example.md expected-datasource.md
1111
cmpenv docs/resources/example.md expected-resource.md
1212
cmpenv docs/functions/example.md expected-function.md
1313
cmpenv docs/ephemeral-resources/example.md expected-ephemeral-resource.md
14-
cmpenv docs/actions/unlinked_example.md expected-unlinked-action.md
14+
cmpenv docs/actions/example.md expected-action.md
1515

1616

1717
-- expected-output.txt --
@@ -29,26 +29,26 @@ function "example" fallback template exists, creating template
2929
generating missing ephemeral resource content
3030
ephemeral resource "scaffolding_example" fallback template exists, creating template
3131
generating missing action content
32-
action "scaffolding_unlinked_example" fallback template exists, creating template
32+
action "scaffolding_example" fallback template exists, creating template
3333
generating missing provider content
3434
provider "terraform-provider-scaffolding" template exists, skipping
3535
rendering static website
3636
cleaning rendered website dir
3737
rendering templated website to static markdown
38-
rendering "actions/unlinked_example.md.tmpl"
38+
rendering "actions/example.md.tmpl"
3939
rendering "data-sources/example.md.tmpl"
4040
rendering "ephemeral-resources/example.md.tmpl"
4141
rendering "functions/example.md.tmpl"
4242
rendering "index.md.tmpl"
4343
rendering "resources/example.md.tmpl"
44-
-- expected-unlinked-action.md --
44+
-- expected-action.md --
4545
# Data Fields
4646

47-
Name: scaffolding_unlinked_example
47+
Name: scaffolding_example
4848
Type: Action
49-
Description: Example unlinked action
49+
Description: Example action
5050
HasExample: true
51-
ExampleFile: $WORK/examples/actions/scaffolding_unlinked_example/action.tf
51+
ExampleFile: $WORK/examples/actions/scaffolding_example/action.tf
5252
ProviderName: terraform-provider-scaffolding
5353
ProviderShortName: scaffolding
5454
RenderedProviderName: terraform-provider-scaffolding
@@ -70,7 +70,7 @@ SchemaMarkdown: <!-- action schema generated by tfplugindocs -->
7070
lower: action
7171
plainmarkdown: Action
7272
prefixlines: Prefix: Action
73-
split: [scaffolding unlinked example]
73+
split: [scaffolding example]
7474
title: Action
7575
trimspace: Action
7676
upper: ACTION
@@ -80,13 +80,13 @@ upper: ACTION
8080
printf tffile:
8181
## Example Usage
8282

83-
{{tffile "$WORK/examples/actions/scaffolding_unlinked_example/action.tf"}}
83+
{{tffile "$WORK/examples/actions/scaffolding_example/action.tf"}}
8484

8585
tffile:
8686
## Example Usage
8787

8888
```terraform
89-
action "scaffolding_unlinked_example" "example" {
89+
action "scaffolding_example" "example" {
9090
config {
9191
required_attr = "some-value"
9292
}
@@ -665,8 +665,8 @@ The document generation tool looks for files in the following locations by defau
665665
* **provider/provider.tf** example file for the provider index page
666666
* **data-sources/`full data source name`/data-source.tf** example file for the named data source page
667667
* **resources/`full resource name`/resource.tf** example file for the named data source page
668-
-- examples/actions/scaffolding_unlinked_example/action.tf --
669-
action "scaffolding_unlinked_example" "example" {
668+
-- examples/actions/scaffolding_example/action.tf --
669+
action "scaffolding_example" "example" {
670670
config {
671671
required_attr = "some-value"
672672
}
@@ -723,7 +723,7 @@ resource "scaffolding_example" "example" {
723723
}
724724
},
725725
"action_schemas": {
726-
"scaffolding_unlinked_example": {
726+
"scaffolding_example": {
727727
"version": 0,
728728
"block": {
729729
"attributes": {
@@ -740,10 +740,9 @@ resource "scaffolding_example" "example" {
740740
"optional": true
741741
}
742742
},
743-
"description": "Example unlinked action",
743+
"description": "Example action",
744744
"description_kind": "plain"
745-
},
746-
"unlinked": {}
745+
}
747746
}
748747
},
749748
"resource_schemas": {

cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_legacy_docs.txtar

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ cmp templates/ephemeral-resources/example.markdown docs/ephemeral-resources/exam
2727
cmp templates/ephemeral-resources/example.html.markdown docs/ephemeral-resources/example.html.markdown
2828
cmp templates/ephemeral-resources/example.html.md docs/ephemeral-resources/example.html.md
2929

30-
cmp templates/actions/unlinked_example.md docs/actions/unlinked_example.md
31-
cmp templates/actions/unlinked_example.markdown docs/actions/unlinked_example.markdown
32-
cmp templates/actions/unlinked_example.html.markdown docs/actions/unlinked_example.html.markdown
33-
cmp templates/actions/unlinked_example.html.md docs/actions/unlinked_example.html.md
30+
cmp templates/actions/example.md docs/actions/example.md
31+
cmp templates/actions/example.markdown docs/actions/example.markdown
32+
cmp templates/actions/example.html.markdown docs/actions/example.html.markdown
33+
cmp templates/actions/example.html.md docs/actions/example.html.md
3434

3535
cmp templates/index.md docs/index.md
3636
cmp templates/index.markdown docs/index.markdown
@@ -51,16 +51,16 @@ function "example" static file exists, skipping
5151
generating missing ephemeral resource content
5252
ephemeral resource "scaffolding_example" static file exists, skipping
5353
generating missing action content
54-
action "scaffolding_unlinked_example" static file exists, skipping
54+
action "scaffolding_example" static file exists, skipping
5555
generating missing provider content
5656
provider "terraform-provider-scaffolding" static file exists, skipping
5757
rendering static website
5858
cleaning rendered website dir
5959
rendering templated website to static markdown
60-
copying non-template file: "actions/unlinked_example.html.markdown"
61-
copying non-template file: "actions/unlinked_example.html.md"
62-
copying non-template file: "actions/unlinked_example.markdown"
63-
copying non-template file: "actions/unlinked_example.md"
60+
copying non-template file: "actions/example.html.markdown"
61+
copying non-template file: "actions/example.html.md"
62+
copying non-template file: "actions/example.markdown"
63+
copying non-template file: "actions/example.md"
6464
copying non-template file: "d/example.html.markdown"
6565
copying non-template file: "d/example.html.md"
6666
copying non-template file: "d/example.markdown"
@@ -81,22 +81,22 @@ copying non-template file: "r/example.html.markdown"
8181
copying non-template file: "r/example.html.md"
8282
copying non-template file: "r/example.markdown"
8383
copying non-template file: "r/example.md"
84-
-- templates/actions/unlinked_example.md --
84+
-- templates/actions/example.md --
8585
# Data Fields
8686

8787
Name: {{.Name}}
8888
Type: {{.Type}}
89-
-- templates/actions/unlinked_example.markdown --
89+
-- templates/actions/example.markdown --
9090
# Data Fields
9191

9292
Name: {{.Name}}
9393
Type: {{.Type}}
94-
-- templates/actions/unlinked_example.html.markdown --
94+
-- templates/actions/example.html.markdown --
9595
# Data Fields
9696

9797
Name: {{.Name}}
9898
Type: {{.Type}}
99-
-- templates/actions/unlinked_example.html.md --
99+
-- templates/actions/example.html.md --
100100
# Data Fields
101101

102102
Name: {{.Name}}
@@ -211,8 +211,8 @@ The document generation tool looks for files in the following locations by defau
211211
* **provider/provider.tf** example file for the provider index page
212212
* **data-sources/`full data source name`/data-source.tf** example file for the named data source page
213213
* **resources/`full resource name`/resource.tf** example file for the named data source page
214-
-- examples/actions/scaffolding_unlinked_example/action.tf --
215-
action "scaffolding_unlinked_example" "example" {
214+
-- examples/actions/scaffolding_example/action.tf --
215+
action "scaffolding_example" "example" {
216216
config {
217217
required_attr = "some-value"
218218
}
@@ -265,7 +265,7 @@ terraform import scaffolding_example.example "id-123"
265265
}
266266
},
267267
"action_schemas": {
268-
"scaffolding_unlinked_example": {
268+
"scaffolding_example": {
269269
"version": 0,
270270
"block": {
271271
"attributes": {
@@ -282,10 +282,9 @@ terraform import scaffolding_example.example "id-123"
282282
"optional": true
283283
}
284284
},
285-
"description": "Example unlinked action",
285+
"description": "Example action",
286286
"description_kind": "plain"
287-
},
288-
"unlinked": {}
287+
}
289288
}
290289
},
291290
"resource_schemas": {

cmd/tfplugindocs/testdata/scripts/schema-json/generate/framework_provider_success_named_templates.txtar

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ cmpenv docs/data-sources/example.md expected-datasource.md
1111
cmpenv docs/resources/example.md expected-resource.md
1212
cmpenv docs/functions/example.md expected-function.md
1313
cmpenv docs/ephemeral-resources/example.md expected-ephemeral-resource.md
14-
cmpenv docs/actions/unlinked_example.md expected-unlinked-action.md
14+
cmpenv docs/actions/example.md expected-action.md
1515

1616
-- expected-output.txt --
1717
rendering website for provider "terraform-provider-scaffolding" (as "Scaffolding")
@@ -28,26 +28,26 @@ function "example" template exists, skipping
2828
generating missing ephemeral resource content
2929
ephemeral resource "scaffolding_example" template exists, skipping
3030
generating missing action content
31-
action "scaffolding_unlinked_example" template exists, skipping
31+
action "scaffolding_example" template exists, skipping
3232
generating missing provider content
3333
provider "terraform-provider-scaffolding" template exists, skipping
3434
rendering static website
3535
cleaning rendered website dir
3636
rendering templated website to static markdown
37-
rendering "actions/unlinked_example.md.tmpl"
37+
rendering "actions/example.md.tmpl"
3838
rendering "data-sources/example.md.tmpl"
3939
rendering "ephemeral-resources/example.md.tmpl"
4040
rendering "functions/example.md.tmpl"
4141
rendering "index.md.tmpl"
4242
rendering "resources/example.md.tmpl"
43-
-- expected-unlinked-action.md --
43+
-- expected-action.md --
4444
# Data Fields
4545

46-
Name: scaffolding_unlinked_example
46+
Name: scaffolding_example
4747
Type: Action
48-
Description: Example unlinked action
48+
Description: Example action
4949
HasExample: true
50-
ExampleFile: $WORK/examples/actions/scaffolding_unlinked_example/action.tf
50+
ExampleFile: $WORK/examples/actions/scaffolding_example/action.tf
5151
ProviderName: terraform-provider-scaffolding
5252
ProviderShortName: Scaffolding
5353
RenderedProviderName: Scaffolding
@@ -69,7 +69,7 @@ SchemaMarkdown: <!-- action schema generated by tfplugindocs -->
6969
lower: action
7070
plainmarkdown: Action
7171
prefixlines: Prefix: Action
72-
split: [scaffolding unlinked example]
72+
split: [scaffolding example]
7373
title: Action
7474
trimspace: Action
7575
upper: ACTION
@@ -79,13 +79,13 @@ upper: ACTION
7979
printf tffile:
8080
## Example Usage
8181

82-
{{tffile "$WORK/examples/actions/scaffolding_unlinked_example/action.tf"}}
82+
{{tffile "$WORK/examples/actions/scaffolding_example/action.tf"}}
8383

8484
tffile:
8585
## Example Usage
8686

8787
```terraform
88-
action "scaffolding_unlinked_example" "example" {
88+
action "scaffolding_example" "example" {
8989
config {
9090
required_attr = "some-value"
9191
}
@@ -378,7 +378,7 @@ resource "scaffolding_example" "example" {
378378
configurable_attribute = "some-value"
379379
}
380380
```
381-
-- templates/actions/unlinked_example.md.tmpl --
381+
-- templates/actions/example.md.tmpl --
382382
# Data Fields
383383

384384
Name: {{.Name}}
@@ -681,8 +681,8 @@ The document generation tool looks for files in the following locations by defau
681681
* **provider/provider.tf** example file for the provider index page
682682
* **data-sources/`full data source name`/data-source.tf** example file for the named data source page
683683
* **resources/`full resource name`/resource.tf** example file for the named data source page
684-
-- examples/actions/scaffolding_unlinked_example/action.tf --
685-
action "scaffolding_unlinked_example" "example" {
684+
-- examples/actions/scaffolding_example/action.tf --
685+
action "scaffolding_example" "example" {
686686
config {
687687
required_attr = "some-value"
688688
}
@@ -752,7 +752,7 @@ terraform import scaffolding_example.example "id-123"
752752
}
753753
},
754754
"action_schemas": {
755-
"scaffolding_unlinked_example": {
755+
"scaffolding_example": {
756756
"version": 0,
757757
"block": {
758758
"attributes": {
@@ -769,10 +769,9 @@ terraform import scaffolding_example.example "id-123"
769769
"optional": true
770770
}
771771
},
772-
"description": "Example unlinked action",
772+
"description": "Example action",
773773
"description_kind": "plain"
774-
},
775-
"unlinked": {}
774+
}
776775
}
777776
},
778777
"resource_schemas": {

0 commit comments

Comments
 (0)