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

Document what are considered breaking changes #12420

Closed
melinath opened this issue Aug 29, 2022 · 2 comments
Closed

Document what are considered breaking changes #12420

melinath opened this issue Aug 29, 2022 · 2 comments
Assignees
Labels
documentation mmv1-generator Provider-wide changes to resource templates or other generator changes size/m technical-debt

Comments

@melinath
Copy link
Collaborator

One of the things I most frequently have to reference is: is X a breaking change. It would be great to have a document that lays out known breakable changes in an easily-searchable way, with a brief description of why it's a breaking change and what alternatives might be available.

For example: changing default value is a breaking change. The only backwards compatible change w/ changing default values (whether adding or removing) is adding a default to a previously-Required field, or changing a field w/ a default to O+C

@melinath melinath added technical-debt mmv1-generator Provider-wide changes to resource templates or other generator changes labels Aug 29, 2022
@rileykarson rileykarson added this to the Near-Term Goals milestone Sep 6, 2022
@ScottSuarez
Copy link
Collaborator

closed with GoogleCloudPlatform/magic-modules#6664

@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation mmv1-generator Provider-wide changes to resource templates or other generator changes size/m technical-debt
Projects
None yet
Development

No branches or pull requests

3 participants