Catch fork up to v0.20.0

.changes/0.20.0.md

@@ -0,0 +1,18 @@
+## 0.20.0 (November 06, 2024)
+
+NOTES:
+
+* all: This Go module has been updated to Go 1.22 per the [Go support policy](https://go.dev/doc/devel/release#policy). It is recommended to review the [Go 1.22 release notes](https://go.dev/doc/go1.22) before upgrading. Any consumers building on earlier Go versions may experience errors. ([#400](https://github.com/hashicorp/terraform-plugin-docs/issues/400))
+
+FEATURES:
+
+* generate: Add support for ephemeral resources ([#415](https://github.com/hashicorp/terraform-plugin-docs/issues/415))
+* migrate: Add support for ephemeral resources ([#415](https://github.com/hashicorp/terraform-plugin-docs/issues/415))
+* validate: Add support for ephemeral resources ([#415](https://github.com/hashicorp/terraform-plugin-docs/issues/415))
+
+BUG FIXES:
+
+* validate: File extension check now runs on `index.*` files instead of just `index.md` files. ([#413](https://github.com/hashicorp/terraform-plugin-docs/issues/413))
+* validate: File extension check now specifies the correct valid extensions in the error message. ([#413](https://github.com/hashicorp/terraform-plugin-docs/issues/413))
+* validate: Front matter check now runs with the correct options on legacy index files. ([#413](https://github.com/hashicorp/terraform-plugin-docs/issues/413))
+

.github/workflows/ci-changie.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Ensure terraform-devex-repos is updated on version changes.
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       # Ensure terraform-devex-repos is updated on version changes.
       - uses: miniscruff/changie-action@6dcc2533cac0495148ed4046c438487e4dceaa23 # v2.0.0
         with:

.github/workflows/compliance.yml

@@ -11,7 +11,7 @@ jobs:
   copywrite:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: hashicorp/setup-copywrite@32638da2d4e81d56a0764aa1547882fc4d209636 # v1.1.3
       - run: copywrite headers --plan
       - run: copywrite license --plan

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
           # Avoid persisting GITHUB_TOKEN credentials as they take priority over our service account PAT for `git push` operations
@@ -54,7 +54,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
           # Default input is the SHA that initially triggered the workflow. As we created a new commit in the previous job,
@@ -79,12 +79,12 @@ jobs:
       contents: write # Needed for goreleaser to create GitHub release
       issues: write # Needed for goreleaser to close associated milestone
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           ref: ${{ inputs.versionNumber }}
           fetch-depth: 0
 
-      - uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
+      - uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
         with:
           go-version-file: 'go.mod'
 

.github/workflows/test.yml

@@ -21,13 +21,13 @@ jobs:
           git config --global core.eol lf
 
       - name: Check out code
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Go
-        uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
+        uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
         with:
           go-version-file: 'go.mod'
       - name: Run linters
-        uses: golangci/golangci-lint-action@a4f60bb28d35aeee14e6880718e0c85ff1882e64 # v6.0.1
+        uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
         with:
           version: latest
           args: --timeout=3m

.golangci.yml

@@ -7,22 +7,20 @@ linters:
   enable:
     - durationcheck
     - errcheck
-    - exportloopref
     - forcetypeassert
     - gofmt
     - gosimple
+    - govet
     - ineffassign
     - makezero
     - misspell
     - nilerr
     - paralleltest
     - predeclared
     - staticcheck
-    - tenv
     - unconvert
     - unparam
     - unused
-    - vet
 
 run:
   # Prevent false positive timeouts in CI

CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.20.0 (November 06, 2024)
+
+NOTES:
+
+* all: This Go module has been updated to Go 1.22 per the [Go support policy](https://go.dev/doc/devel/release#policy). It is recommended to review the [Go 1.22 release notes](https://go.dev/doc/go1.22) before upgrading. Any consumers building on earlier Go versions may experience errors. ([#400](https://github.com/hashicorp/terraform-plugin-docs/issues/400))
+
+FEATURES:
+
+* generate: Add support for ephemeral resources ([#415](https://github.com/hashicorp/terraform-plugin-docs/issues/415))
+* migrate: Add support for ephemeral resources ([#415](https://github.com/hashicorp/terraform-plugin-docs/issues/415))
+* validate: Add support for ephemeral resources ([#415](https://github.com/hashicorp/terraform-plugin-docs/issues/415))
+
+BUG FIXES:
+
+* validate: File extension check now runs on `index.*` files instead of just `index.md` files. ([#413](https://github.com/hashicorp/terraform-plugin-docs/issues/413))
+* validate: File extension check now specifies the correct valid extensions in the error message. ([#413](https://github.com/hashicorp/terraform-plugin-docs/issues/413))
+* validate: Front matter check now runs with the correct options on legacy index files. ([#413](https://github.com/hashicorp/terraform-plugin-docs/issues/413))
+
 ## 0.19.4 (June 04, 2024)
 
 NOTES:

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                                                                               |
 |------------------------:|:------:|-------------------------------------------------------------------------------------------|

cmd/tfplugindocs/testdata/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

cmd/tfplugindocs/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

cmd/tfplugindocs/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

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

cmd/tfplugindocs/testdata/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