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

Pub/Sub - Change Allowed Persistence Regions to Set in 'google_pubsub_topic' #13529

Open
wants to merge 1 commit into
base: FEATURE-BRANCH-major-release-6.0.0
Choose a base branch
from

Conversation

abbrowne126
Copy link

@abbrowne126 abbrowne126 commented Apr 3, 2025

Fixes hashicorp/terraform-provider-google#21650

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

Change `google_pubsub_topic.allowed_persistence_regions` from `List` to `Set` type.

@modular-magician modular-magician added the awaiting-approval Pull requests that need reviewer's approval to run presubmit tests label Apr 3, 2025
@abbrowne126 abbrowne126 closed this Apr 3, 2025
@abbrowne126 abbrowne126 reopened this Apr 3, 2025
@github-actions github-actions bot requested a review from roaks3 April 3, 2025 15:55
Copy link

github-actions bot commented Apr 3, 2025

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@roaks3, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@roaks3
Copy link
Contributor

roaks3 commented Apr 4, 2025

Per https://googlecloudplatform.github.io/magic-modules/breaking-changes/make-a-breaking-change/#in-minor-releases, this seems like it could qualify as a change for a minor release:

Changing a List to a Set where the field is unordered and the order returned from the API changes unpredictably.

Could you confirm if this issue occurs whenever the field is used, and that the order of elements is not predictable (ie. it can keep changing over time). Effectively, if these things are true, there is virtually no way someone would be able to use the field as a List.

@abbrowne126
Copy link
Author

Per https://googlecloudplatform.github.io/magic-modules/breaking-changes/make-a-breaking-change/#in-minor-releases, this seems like it could qualify as a change for a minor release:

Changing a List to a Set where the field is unordered and the order returned from the API changes unpredictably.

Could you confirm if this issue occurs whenever the field is used, and that the order of elements is not predictable (ie. it can keep changing over time). Effectively, if these things are true, there is virtually no way someone would be able to use the field as a List.

I opened a PR as a minor release and was told to put it in the major release #13510

I can confirm this - there is a permadiff on this field, and additionally the field should be a set based on its behavior

@roaks3
Copy link
Contributor

roaks3 commented Apr 4, 2025

Ok, let me confirm with the team. This scenario falls in a bit of a grey area in that it is technically an "exception", but we have also precedence for including cases like this in a minor release.

@abbrowne126
Copy link
Author

Sounds good, thank you Ryan. Just one question: I am guessing I shouldn't list it as a breaking change in the release notes if it goes into a minor release?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-approval Pull requests that need reviewer's approval to run presubmit tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants