Skip to content

refactor(core/types)!: fix with_user_metadata signature #5960

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 21, 2025
Merged

refactor(core/types)!: fix with_user_metadata signature #5960

merged 1 commit into from
May 21, 2025
+9 −9

Conversation

meteorgan
Copy link
Contributor

@meteorgan meteorgan commented Apr 5, 2025 •
edited
Loading

Which issue does this PR close?

None

Rationale for this change

Currently, the method signature of with_user_metadata in the metadata module has a different signature to the with_xxx methods, which is a bit confusing.

What changes are included in this PR?

Are there any user-facing changes?

None

@meteorgan meteorgan changed the title chore(core/types): rename with_user_metadata to set_user_metadata to maintain consistency with other methods in the metadata chore(core/types): rename with_user_metadata to set_user_metadata Apr 5, 2025
@meteorgan meteorgan marked this pull request as ready for review April 5, 2025 12:29
@meteorgan meteorgan requested a review from Xuanwo as a code owner April 5, 2025 12:29
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. core releases-note/chore The PR has a title that begins with "chore" or changes other small things that hard to tell services/azblob services/cos services/gcs services/obs services/oss services/s3 services/swift labels Apr 5, 2025
Xuanwo
Xuanwo reviewed Apr 5, 2025
View reviewed changes
Copy link
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

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

Nice catch. However, since either change is a breaking change, we'll hold off on this PR for now until we're ready for the next major release.

@Xuanwo Xuanwo marked this pull request as draft April 5, 2025 13:14
@meteorgan meteorgan force-pushed the fix-set-user-metadata branch from 40043c3 to 44f2524 Compare April 6, 2025 13:45
@meteorgan meteorgan changed the title chore(core/types): rename with_user_metadata to set_user_metadata chore(core/types): fix with_user_metadata signature Apr 6, 2025
@Xuanwo
Copy link
Member

Xuanwo commented Apr 6, 2025

Thank you @meteorgan for this! I have marked this as breaking-change. Let's hold on this PR until next major release.

@Xuanwo
Copy link
Member

Xuanwo commented May 21, 2025

We are ready to go!

@Xuanwo Xuanwo marked this pull request as ready for review May 21, 2025 09:51
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 21, 2025
@Xuanwo Xuanwo changed the title chore(core/types): fix with_user_metadata signature refactor(core/types)!: fix with_user_metadata signature May 21, 2025
@Xuanwo Xuanwo added releases-note/refactor The PR does a refactor on code or has a title that begins with "refactor" and removed services/cos services/swift releases-note/chore The PR has a title that begins with "chore" or changes other small things that hard to tell labels May 21, 2025
@Xuanwo Xuanwo merged commit e317c8d into main May 21, 2025
282 checks passed
@Xuanwo Xuanwo deleted the fix-set-user-metadata branch May 21, 2025 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Xuanwo Xuanwo Xuanwo approved these changes

Assignees
No one assigned
Labels
breaking-changes core lgtm This PR has been approved by a maintainer releases-note/refactor The PR does a refactor on code or has a title that begins with "refactor" size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@meteorgan @Xuanwo