hashicorp / hashicorp/terraform-plugin-framework

Log SDK Version Information

Open
#238 1 comment 2 reactions 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
384
Forks
107
Avg merge
3m
Merged PRs (30d)
1

Description

### Version

```
v0.5.0
```

### Use-cases

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

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

```go
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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.