-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add deprecation message for generated beta fields. #2142
Conversation
For #2143. Marking as a WIP because I don't want to submit this until we're definitely sure this is what we're doing, but at least for now I wouldn't mind some feedback on wording. |
Actually, a better reason for this being a WIP is that some of these fields/resources have reached GA now, and should be marked as such. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd ideally like to get a guide page up on the website explaining the multi-provider situation, so we can link to it from the deprecation message. I think we should also use the Resource.DeprecationMessage
property when entire resources are getting deprecated, instead of setting it on each field.
I think
Use terraform-provider-google-beta to continue using it.
Makes sense to us, but to a user it may be confusing. Something like
Use the $RESOURCE resource in the terraform-provider-google-beta provider to continue using it. See https://terraform.io/docs/provider/google/guides/provider-versions.html for more details on beta {field/resource}s.
may give some more context? The parts I think are important in that:
- calling out that terraform-provider-google-beta is a different provider
- directing them to the resource to use--yes, they should have the same name, but I think it helps underscore that the providers aren't all-in, you can do them on a resource-by-resource basis
- there's a link to some documentation explaining how to use the other provider, because the
provider = "google-beta"
hack won't be intuitive at first.
3ab96de
to
b6f7a24
Compare
a762792
to
de78b19
Compare
de78b19
to
83f9c94
Compare
It would be good if the CHANGELOG documentation would instruct people how to update their existing states... coming from a previous version of the provider. e.g. So I go and remove |
Did you try using it with the |
@paddycarver I did but I do not want to switch to the beta provider that is my point |
Add deprecation message for generated beta fields.
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 feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks! |
/cc @danawillow