terraform-plugin-framework icon indicating copy to clipboard operation
terraform-plugin-framework copied to clipboard

Log SDK Version Information

Open bflad opened this issue 3 years ago • 1 comments

Version

v0.5.0

Use-cases

Providers can be running a variety of SDK packages and versions. Similar to the Terraform CLI:

2021-12-23T16:20:04.565-0500 [INFO]  Terraform version: 1.1.2

It would be great to include SDK version information in the logging.

Attempted Solutions

Asking folks after the fact which SDK version is involved, which might require spelunking which provider version was being used then which SDK version was being used with that provider version.

Proposal

Create a version or meta package which contains the release version information. Ensure release process appropriately updates this information.

Once available, use that version information to output an informational log:

tfsdklog.Info(ctx, "terraform-plugin-framework version: "+meta.SDKVersionString()))

References

  • https://github.com/hashicorp/terraform-plugin-sdk/issues/839
  • https://github.com/hashicorp/terraform-plugin-go/issues/130
  • https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/meta#SDKVersionString

bflad avatar Dec 23 '21 21:12 bflad

@bflad is this version already available somewhere in the package or would this be completely new and has to be somehow included into the build / release process?

timofurrer avatar Feb 24 '23 09:02 timofurrer