Skip to content

Update generated docs for terraform-plugin-docs v0.24.0#63

Draft
Copilot wants to merge 3 commits intodependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.24.0from
copilot/sub-pr-60
Draft

Update generated docs for terraform-plugin-docs v0.24.0#63
Copilot wants to merge 3 commits intodependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.24.0from
copilot/sub-pr-60

Conversation

Copy link

Copilot AI commented Jan 15, 2026

The dependency bump to terraform-plugin-docs v0.24.0 changed the format of generated documentation. The existing docs were generated with v0.21.0 and needed regeneration.

Changes

  • Regenerated resource documentation using tfplugindocs generate
  • Import sections now include introductory text linking to Terraform's import command documentation
  • Added custom resource templates (templates/resources/asymmetric_key.md.tmpl and templates/resources/preshared_key.md.tmpl) to avoid duplicate introduction text in the import sections

The change affects docs/resources/asymmetric_key.md and docs/resources/preshared_key.md. Custom templates were added to ensure the import section uses only the modern format without redundant text.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: OJFord <3946014+OJFord@users.noreply.github.com>
Copy link
Author

Copilot AI commented Jan 15, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • checkpoint-api.hashicorp.com
    • Triggering command: /home/REDACTED/go/bin/tfplugindocs /home/REDACTED/go/bin/tfplugindocs generate 9B2EO-DOFjhlxjsR0B5L/9B2EO-DOFjhlxjsR0B5L -goversion go1.24.11 -c=4 -nolocalimports -importcfg /tmp/go-build2204332430/b282/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/!proton!mail/go-crypto@v1.1.6/openpgp/elgamal/elgamal.go x64/pkg/tool/lin-fPIC (dns block)
    • Triggering command: /tmp/tfws4054071915/terraform /tmp/tfws4054071915/terraform version -json -goversion go1.24.11 -c=4 -nolocalimports -importcfg /tmp/go-build2155899955/b403/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/hashicorp/terraform-registry-address@v0.2.5/errors.go /home/REDACTED/go/pkg/mod/github.com/hashicorp/terraform-registry-address@v0.2.5/module.go conf�� t/decode.go t/decode_number.go (dns block)
    • Triggering command: /tmp/tfws4054071915/terraform /tmp/tfws4054071915/terraform init -no-color -input=false -backend=true -get=false -upgrade=false -plugin-dir=./plugins /tmp/go-build2155899955/b401/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/hashicorp/terraform-plugin-go@v0.27.0/internal/logging/context.go /home/REDACTED/go/pkg/mod/github.com/hashicorp/terraform-plugin-go@v0.27.0/internal/logging/doc.go abis�� n.go n.go (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Update terraform-plugin-docs to version 0.24.0 Update generated docs for terraform-plugin-docs v0.24.0 Jan 15, 2026
Copilot AI requested a review from OJFord January 15, 2026 12:46
Comment on lines +46 to +49
Import is supported using the following syntax:

The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you it's 'correct', because the tfplugindocs lint is passing, but this reads weirdly: there's now two different lines introducing the terraform import command. Something must be wrong with the template?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed by creating custom resource templates. The issue was that tfplugindocs v0.24.0's built-in template still included "Import is supported using the following syntax:" while also adding the new "The terraform import command can be used..." line. The custom templates now only include the modern format. (b1ee455)

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I see the same locally; I've raised hashicorp/terraform-plugin-docs#552.

…lates

Co-authored-by: OJFord <3946014+OJFord@users.noreply.github.com>
Copy link
Author

Copilot AI commented Jan 15, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • checkpoint-api.hashicorp.com
    • Triggering command: /tmp/tfws462860894/terraform /tmp/tfws462860894/terraform version -json -goversion go1.24.11 -c=4 -nolocalimports -importcfg /tmp/go-build573122615/b290/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/hashicorp/go-plugin@v1.6.3/internal/cmdREDACTED/addr_translator.go /home/REDACTED/go/pkg/mod/github.com/hashicorp/go-plugin@v1.6.3/internal/cmdREDACTED/cmd_reattach.go conf�� l/fieldutils/field_maps.go rg/x/exp@v0.0.0--nolocalimports (dns block)
    • Triggering command: /tmp/tfws462860894/terraform /tmp/tfws462860894/terraform init -no-color -input=false -backend=true -get=false -upgrade=false -plugin-dir=./plugins /tmp/go-build573122615/b302/importcfg -pack /home/REDACTED/go/pkg/mod/github.com/hashicorp/yamux@v0.1.1/addr.go /home/REDACTED/go/pkg/mod/github.com/hashicorp/yamux@v0.1.1/const.go abis�� 1/x64=/_/GOROOT x64/src/runtime/-nolocalimports (dns block)
    • Triggering command: /tmp/tfws462860894/terraform /tmp/tfws462860894/terraform providers schema -json -no-color -c=4 -nolocalimports -importcfg /tmp/go-build573122615/b306/importcfg -pack /home/REDACTED/go/pkg/mod/golang.org/x/net@v0.44.0/internal/timeseries/timeseries.go git conf�� disable.go o (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI requested a review from OJFord January 15, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants