Skip to content
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

Provide ForceNew hints in field documentation #71

Open
displague opened this issue Jun 21, 2021 · 3 comments
Open

Provide ForceNew hints in field documentation #71

displague opened this issue Jun 21, 2021 · 3 comments

Comments

@displague
Copy link

displague commented Jun 21, 2021

When ForceNew is enabled on a field, the documentation should note the behavior. While the description could include these details, the behavior behind ForceNew: true is generally consistent throughout providers and resources.

Originally from https://github.com/equinix/terraform-provider-metal/issues/110

@jacobbednarz
Copy link
Contributor

While it would be great to see this in the tool, there is also a work around available. You can check the ForceNew attribute in the schema and append something to the description yourself. Example: https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/internal/provider/provider.go#L23-L48

@sauterp
Copy link

sauterp commented Feb 23, 2023

@jacobbednarz
Copy link
Contributor

to save losing this again, the permalink is https://github.com/cloudflare/terraform-provider-cloudflare/blob/acb3d1923adc4c51288f7db2b5df531d51edeece/internal/sdkv2provider/provider.go#L73

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

No branches or pull requests

3 participants