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

fix: Update the format of "id" output in the "simple-sa" module #123

Merged

Conversation

legal90
Copy link
Contributor

@legal90 legal90 commented Aug 5, 2024

Currently the output id returns a map containing both service account id and e-mail, which is misleading.
There is already a separate output for the e-mail, called email.

So, in this PR I suggest to make the output id returning just a service account ID instead of the map.
I didn't mark this change as a breaking change, because there was no release cut yet since the original implementation of "simple-sa" module was merged.

Make the output "id" returning just a service account ID instead of
the map with ID and an e-mail.
There is already a separate output for the e-mail, called "email".
@legal90 legal90 requested a review from a team as a code owner August 5, 2024 18:51
Copy link
Contributor

@apeabody apeabody left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @legal90!

I think this is reasonable, however we'll need to mark as a breaking change. @legal90 could you add a (simple) docs/upgrading_to_v5.md migration guide similar to https://github.com/terraform-google-modules/terraform-google-service-accounts/blob/master/docs/upgrading_to_v3.md.

@apeabody
Copy link
Contributor

apeabody commented Aug 5, 2024

/gcbrun

@apeabody apeabody changed the title fix: Update the format of "id" output in the "simple-sa" module fix!: Update the format of "id" output in the "simple-sa" module Aug 5, 2024
@legal90
Copy link
Contributor Author

legal90 commented Aug 5, 2024

@apeabody Thank you!
Yes, I can, but I'm not sure what to put there, since simple-sa is not available in the latest v4.2.3, so there are no actual breaking changes between v4.2.3 and this PR.

Should I just assume that a new 4.* release could be cut-off soon, before this PR is [potentially] merged?

@apeabody
Copy link
Contributor

apeabody commented Aug 5, 2024

@apeabody Thank you! Yes, I can, but I'm not sure what to put there, since simple-sa is not available in the latest v4.2.3, so there are no actual breaking changes between v4.2.3 and this PR.

Should I just assume that a new 4.* release could be cut-off soon, before this PR is [potentially] merged?

Thanks for pointing out @legal90 that we don't have a release with it yet! I'll make sure this PR is merged before the next release so we don't have to worry about a breaking change.

@apeabody apeabody changed the title fix!: Update the format of "id" output in the "simple-sa" module fix: Update the format of "id" output in the "simple-sa" module Aug 5, 2024
@apeabody apeabody merged commit 4e586a7 into terraform-google-modules:master Aug 5, 2024
4 checks passed
@apeabody apeabody self-assigned this Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants