Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Clarify when changing a List to a Set is considered breaking #12924

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

roaks3
Copy link
Contributor

@roaks3 roaks3 commented Jan 30, 2025

Follow-up to #12814

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.


@roaks3 roaks3 requested review from a team and melinath and removed request for a team January 30, 2025 18:34
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

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

@roaks3
Copy link
Contributor Author

roaks3 commented Jan 31, 2025

@melinath I can move it, but just wanted to mention that personally I wouldn't have found that page. Could you confirm we're happy with the discoverability of this note on that page?

@melinath
Copy link
Member

melinath commented Jan 31, 2025

I think we should be consistent about where we document the exceptions - they should either all be on "Make a breaking change" or all be on "Types of breaking changes".

Currently we have them on the "Make a breaking change" page because the idea is that the change is a breaking change, it's just that we make an exception in certain edge cases. Documenting it on "Types of breaking changes" would be more indicating that the change is not considered breaking in all cases.

For me the thing that makes "Make a breaking change" preferable is that any breaking change could be safe in a minor release, as long as it fixes a bug that impacts all configurations that include a field or resource. (And I don't want to add caveats to every item on the breaking change list.)

I could potentially be convinced otherwise; if this is something you feel strongly about we should discuss it offline.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants