-
Notifications
You must be signed in to change notification settings - Fork 4.5k
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
Contributor Docs: Add a Default Breaking Change section #25339
Conversation
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.
Thanks @mbfrahry, I left a couple of suggestions on the guide, would you mind taking a look through them?
}, | ||
``` | ||
|
||
But if we do that, people who have created that resource without the attribute specified will see a plan diff when upgrading to this version of the provider like so: |
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 feel like there's supposed to be some example of the diff output here after like so:
, but it looks like it was provided further down, maybe remove like so:
here?
But if we do that, people who have created that resource without the attribute specified will see a plan diff when upgrading to this version of the provider like so: | |
But if we do that, people who have created that resource without the attribute specified will see a plan diff when upgrading to this version of the provider. |
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.
Rename this to guide-breaking-changes.md
This PR is being labeled as "stale" because it has not been updated for 30 or more days. If this PR is still valid, please remove the "stale" label. If this PR is blocked, please add it to the "Blocked" milestone. If you need some help completing this PR, please leave a comment letting us know. Thank you! |
Co-authored-by: stephybun <steph@hashicorp.com>
Co-authored-by: stephybun <steph@hashicorp.com>
Co-authored-by: stephybun <steph@hashicorp.com>
Done! Sorry for the delay here |
@mbfrahry still some pending comments on this one? |
Missed that rename. Taken care of |
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.
LGTM ☎️
Community Note
Description
Adding a section to the contributor docs around how breaking changes can occur when adding Default Values.
PR Checklist
For example: “
resource_name_here
- description of change e.g. adding propertynew_property_name_here
”This is a (please select all that apply):