all: add support for ephemeral resources (#415)

* Update `generate` subcommand to support ephemeral resources * Update `validate` subcommand to support ephemeral resources * Update `migrate` subcommand to support ephemeral resources * Update README.md * Add changelog entries * Update README.md Co-authored-by: Austin Valle <[email protected]> --------- Co-authored-by: Austin Valle <[email protected]>
hashicorp · Nov 1, 2024 · 97bd6c7 · 97bd6c7
1 parent 6c67ef2
commit 97bd6c7
Show file tree

Hide file tree

Showing 34 changed files with 2,366 additions and 517 deletions.
diff --git a/.changes/unreleased/FEATURES-20241031-100833.yaml b/.changes/unreleased/FEATURES-20241031-100833.yaml
@@ -0,0 +1,5 @@
+kind: FEATURES
+body: 'generate: Add support for ephemeral resources'
+time: 2024-10-31T10:08:33.606686-04:00
+custom:
+    Issue: "415"
diff --git a/.changes/unreleased/FEATURES-20241031-100904.yaml b/.changes/unreleased/FEATURES-20241031-100904.yaml
@@ -0,0 +1,5 @@
+kind: FEATURES
+body: 'migrate: Add support for ephemeral resources'
+time: 2024-10-31T10:09:04.175251-04:00
+custom:
+    Issue: "415"
diff --git a/.changes/unreleased/FEATURES-20241031-100919.yaml b/.changes/unreleased/FEATURES-20241031-100919.yaml
@@ -0,0 +1,5 @@
+kind: FEATURES
+body: 'validate: Add support for ephemeral resources'
+time: 2024-10-31T10:09:19.716278-04:00
+custom:
+    Issue: "415"
diff --git a/README.md b/README.md
@@ -112,6 +112,7 @@ When you run `tfplugindocs`, by default from the root directory of a provider co
 * Generate resource template files, if missing
 * Generate data source template files, if missing
 * Generate function template files, if missing (Requires Terraform v1.8.0+)
+* Generate ephemeral resource template files, if missing (Requires Terraform v1.10.0+)
 * Copy all non-template files to the output website directory
 * Process all the remaining templates to generate files for the output website directory
 
@@ -193,16 +194,18 @@ For templates:
 
 > **NOTE:** In the following conventional paths for templates, `<data source name>`, `<resource name>`, and `<function name>` do not include the provider prefix.
 
-| Path                                                  | Description                            |
-|-------------------------------------------------------|----------------------------------------|
-| `templates/`                                          | Root of templated docs                 |
-| `templates/index.md[.tmpl]`                           | Docs index page (or template)          |
-| `templates/data-sources.md[.tmpl]`                    | Generic data source page (or template) |
-| `templates/data-sources/<data source name>.md[.tmpl]` | Data source page (or template)         |
-| `templates/functions.md[.tmpl]`                       | Generic function page (or template)    |
-| `templates/functions/<function name>.md[.tmpl]`       | Function page (or template)            |
-| `templates/resources.md[.tmpl]`                       | Generic resource page (or template)    |
-| `templates/resources/<resource name>.md[.tmpl]`       | Resource page (or template)            |
+| Path                                                               | Description                                   |
+|--------------------------------------------------------------------|-----------------------------------------------|
+| `templates/`                                                       | Root of templated docs                        |
+| `templates/index.md[.tmpl]`                                        | Docs index page (or template)                 |
+| `templates/data-sources.md[.tmpl]`                                 | Generic data source page (or template)        |
+| `templates/data-sources/<data source name>.md[.tmpl]`              | Data source page (or template)                |
+| `templates/ephemeral-resources.md[.tmpl]`                          | Generic ephemeral resource page (or template) |
+| `templates/ephemeral-resources/<ephemeral resource name>.md[.tmpl]` | Ephemeral resource page (or template)         |
+| `templates/functions.md[.tmpl]`                                    | Generic function page (or template)           |
+| `templates/functions/<function name>.md[.tmpl]`                    | Function page (or template)                   |
+| `templates/resources.md[.tmpl]`                                    | Generic resource page (or template)           |
+| `templates/resources/<resource name>.md[.tmpl]`                    | Resource page (or template)                   |
 
 Note: the `.tmpl` extension is necessary, for the file to be correctly handled as a template.
 
@@ -211,14 +214,15 @@ For examples:
 > **NOTE:** In the following conventional paths for examples, `<data source name>` and `<resource name>` include the provider prefix as well, but the provider prefix is **NOT** included in`<function name>`.
 > For example, the data source [`caller_identity`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) in the `aws` provider would have an "example" conventional path of: `examples/data-sources/aws_caller_identity/data-source.tf`
 
-| Path                                                      | Description                     |
-|-----------------------------------------------------------|---------------------------------|
-| `examples/`                                               | Root of examples                |
-| `examples/provider/provider.tf`                           | Provider example config         |
-| `examples/data-sources/<data source name>/data-source.tf` | Data source example config      |
-| `examples/functions/<function name>/function.tf`          | Function example config         |
-| `examples/resources/<resource name>/resource.tf`          | Resource example config         |
-| `examples/resources/<resource name>/import.sh`            | Resource example import command |
+| Path                                                                      | Description                       |
+|---------------------------------------------------------------------------|-----------------------------------|
+| `examples/`                                                               | Root of examples                  |
+| `examples/provider/provider.tf`                                           | Provider example config           |
+| `examples/data-sources/<data source name>/data-source.tf`                 | Data source example config        |
+| `examples/ephemeral-resources/<ephemeral resource>/ephemeral-resource.tf` | Ephemeral resource example config |
+| `examples/functions/<function name>/function.tf`                          | Function example config           |
+| `examples/resources/<resource name>/resource.tf`                          | Resource example config           |
+| `examples/resources/<resource name>/import.sh`                            | Resource example import command   |
 
 #### Migration
 
@@ -229,25 +233,27 @@ The `migrate` subcommand assumes the following conventional paths for the render
 
 Legacy website directory structure:
 
-| Path                                                  | Description                 |
-|-------------------------------------------------------|-----------------------------|
-| `website/`                                            | Root of website docs        |
-| `website/docs/guides`                                 | Root of guides subdirectory |
-| `website/docs/index.html.markdown`                    | Docs index page             |
-| `website/docs/d/<data source name>.html.markdown`     | Data source page            |
-| `website/docs/functons/<function name>.html.markdown` | Functions page              |
-| `website/docs/r/<resource name>.html.markdown`        | Resource page               |
+| Path                                                                       | Description                 |
+|----------------------------------------------------------------------------|-----------------------------|
+| `website/`                                                                 | Root of website docs        |
+| `website/docs/guides`                                                      | Root of guides subdirectory |
+| `website/docs/index.html.markdown`                                         | Docs index page             |
+| `website/docs/d/<data source name>.html.markdown`                          | Data source page            |
+| `website/docs/ephemeral-resources/<ephemeral resource name>.html.markdown` | Ephemeral resource page     |
+| `website/docs/functons/<function name>.html.markdown`                      | Functions page              |
+| `website/docs/r/<resource name>.html.markdown`                             | Resource page               |
 
 Docs website directory structure:
 
-| Path                                                 | Description                 |
-|------------------------------------------------------|-----------------------------|
-| `docs/`                                              | Root of website docs        |
-| `docs/guides`                                        | Root of guides subdirectory |
-| `docs/index.html.markdown`                           | Docs index page             |
-| `docs/data-sources/<data source name>.html.markdown` | Data source page            |
-| `docs/functions/<function name>.html.markdown`       | Function page               |
-| `docs/resources/<resource name>.html.markdown`       | Resource page               |
+| Path                                                               | Description                 |
+|--------------------------------------------------------------------|-----------------------------|
+| `docs/`                                                            | Root of website docs        |
+| `docs/guides`                                                      | Root of guides subdirectory |
+| `docs/index.html.markdown`                                         | Docs index page             |
+| `docs/data-sources/<data source name>.html.markdown`               | Data source page            |
+| `docs/ephemeral-resources/<ephemeral resource name>.html.markdown` | Ephemeral resource page     |
+| `docs/functions/<function name>.html.markdown`                     | Function page               |
+| `docs/resources/<resource name>.html.markdown`                     | Resource page               |
 
 Files named `index` (before the first `.`) in the website docs root directory and files in the `website/docs/d/`, `website/docs/r/`, `docs/data-sources/`, 
 and `docs/resources/` subdirectories will be converted to `tfplugindocs` templates. 
@@ -275,7 +281,7 @@ using the following data fields and functions:
 | `.RenderedProviderName` | string | Value provided via argument `--rendered-provider-name`, otherwise same as `.ProviderName` |
 |       `.SchemaMarkdown` | string | a Markdown formatted Provider Schema definition                                           |
 
-##### Resources / Data Source Fields
+##### Managed Resource / Ephemeral Resource / Data Source Fields
 
 |                   Field |  Type  | Description                                                                               |
 |------------------------:|:------:|-------------------------------------------------------------------------------------------|

diff --git a/...stdata/scripts/provider-build/generate/framework_provider_success_generic_templates.txtar b/...stdata/scripts/provider-build/generate/framework_provider_success_generic_templates.txtar
@@ -26,6 +26,7 @@ resource "scaffolding_example" fallback template exists, creating template
 generating missing data source content
 data-source "scaffolding_example" fallback template exists, creating template
 generating missing function content
+generating missing ephemeral resource content
 generating missing provider content
 provider "terraform-provider-scaffolding" template exists, skipping
 rendering static website

diff --git a/...testdata/scripts/provider-build/generate/framework_provider_success_named_templates.txtar b/...testdata/scripts/provider-build/generate/framework_provider_success_named_templates.txtar
@@ -26,6 +26,7 @@ resource "scaffolding_example" template exists, skipping
 generating missing data source content
 data-source "scaffolding_example" template exists, skipping
 generating missing function content
+generating missing ephemeral resource content
 generating missing provider content
 provider "terraform-provider-scaffolding" template exists, skipping
 rendering static website

diff --git a/...cs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar b/...cs/testdata/scripts/provider-build/generate/framework_provider_success_no_templates.txtar
@@ -24,6 +24,7 @@ generating new template for "scaffolding_example"
 generating missing data source content
 generating new template for data-source "scaffolding_example"
 generating missing function content
+generating missing ephemeral resource content
 generating missing provider content
 generating new template for "terraform-provider-scaffolding"
 rendering static website

diff --git a/cmd/tfplugindocs/testdata/scripts/provider-build/generate/null_provider_success.txtar b/cmd/tfplugindocs/testdata/scripts/provider-build/generate/null_provider_success.txtar
@@ -23,6 +23,7 @@ resource "null_resource" fallback template exists, creating template
 generating missing data source content
 data-source "null_data_source" fallback template exists, creating template
 generating missing function content
+generating missing ephemeral resource content
 generating missing provider content
 provider "terraform-provider-null" template exists, skipping
 rendering static website

diff --git a/...estdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar b/...estdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar
@@ -19,6 +19,7 @@ generating new template for "scaffolding_example"
 generating missing data source content
 generating missing function content
 generating new template for function "scaffolding"
+generating missing ephemeral resource content
 generating missing provider content
 generating new template for "terraform-provider-scaffolding"
 rendering static website