Add release interoperability

tenthirtyam commented 1 year ago

Code of Conduct

[X] I have read and agree to the project's Code of Conduct.

Provider Version

All

Motivation

We've neglected providing the version interoperability detail for the provider in the releases and documentation.

In addition, the SDK is based on v4.5.x so there may be some incompatibility for v5.x.

Suggestion

Update README.md to reference the documentation on the Terraform Registry.
Update /docs/index.md with a table that provides interoperability information.
Update CHANGELOG.md with:
- Add reference the documentation on the Terraform Registry.
- For interoperability changes:
  - Adds support for VMware Cloud Foundation x.
  - BREAKING CHANGE: Removes support for VMware Cloud Foundation x.
This content will be copied to the GitHub release details.

tenthirtyam commented 8 months ago

@stoyanzhelyazkov couod you take a look at adding this to the project and the registry landing docs?

spacegospod commented 7 months ago

@stoyanzhelyazkov couod you take a look at adding this to the project and the registry landing docs?

Hey Ryan, this one seems to have flown under my radar.

AFAIK we don't officially support anything past 4.5.2 yet. Most of the resources work well with 5.X (at least in my experience) but we can't provide a guarantee until we bump the bindings and test everything.

Still, it worth it to make sure that this is clearly reflected in the .md files I will see what I can do

github-actions[bot] commented 6 months ago

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

vmware / terraform-provider-vcf