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

Contributor Docs: Add a Default Breaking Change section #25339

Merged
merged 6 commits into from
May 29, 2024

Conversation

mbfrahry
Copy link
Member

@mbfrahry mbfrahry commented Mar 20, 2024

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Adding a section to the contributor docs around how breaking changes can occur when adding Default Values.

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change
  • Documentation

Copy link
Member

@stephybun stephybun left a 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:
Copy link
Member

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?

Suggested change
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.

contributing/topics/defaults-and-breaking-changes.md Outdated Show resolved Hide resolved
contributing/topics/guide-new-fields-to-resource.md Outdated Show resolved Hide resolved
contributing/topics/defaults-and-breaking-changes.md Outdated Show resolved Hide resolved
Copy link
Member

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

Copy link

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!

@github-actions github-actions bot added the stale label Apr 22, 2024
Co-authored-by: stephybun <steph@hashicorp.com>
mbfrahry and others added 2 commits May 21, 2024 13:36
Co-authored-by: stephybun <steph@hashicorp.com>
Co-authored-by: stephybun <steph@hashicorp.com>
@mbfrahry
Copy link
Member Author

Done! Sorry for the delay here

@github-actions github-actions bot removed the stale label May 21, 2024
@tombuildsstuff
Copy link
Member

@mbfrahry still some pending comments on this one?

@mbfrahry
Copy link
Member Author

Missed that rename. Taken care of

Copy link
Collaborator

@katbyte katbyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ☎️

@stephybun stephybun merged commit 65ed1ad into main May 29, 2024
2 checks passed
@stephybun stephybun deleted the contributor-default-breaking-change branch May 29, 2024 05:37
@github-actions github-actions bot added this to the v3.106.0 milestone May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants