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

[release/2.8 backport] deprecate ReadSeekCloser in favor of io.ReadSeekCloser #4244

Conversation

thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented Jan 6, 2024

backport of:

relates to:

back porting these so that (if another 2.8.x patch release is done), we can give a warning out to users that this will be removed in v3

Embed the interface that we're mocking; calling any of it's methods
that are not implemented will panic, so should give the same result
as before.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 2cd52d5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Go's io package in stdlib now defines this interface, so we can switch
to using that instead.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 019ead8)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
…Closer

General convention is to define interfaces on the receiver side, and
to return concrete types.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit d71ad5b)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Remove some intermediate variables, and use struct literals instead.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 1d8cd5e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@milosgajdos
Copy link
Member

Seb, do we want to bother with another 2.8 release? It'll be minimal if we do, delivering negligible value to users 🤷‍♂️ not sure if worth it

Copy link
Member

@milosgajdos milosgajdos left a comment

Choose a reason for hiding this comment

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

I'm ok with this but I don't think we need this. We should consider this branch as soon-to-be EOL.

@wy65701436
Copy link
Collaborator

do we need this for v2.8? We should maintain this branch for CVE or bug?

@thaJeztah
Copy link
Member Author

The idea is to remove these in main (v3), but to have this branch to give users currently using v2 a "heads-up" that if they're using these, they are deprecated and to be removed;

@thaJeztah
Copy link
Member Author

We should consider this branch as soon-to-be EOL.

For the binaries, I think that makes sense; for the module, we may have to consider keeping the branch "maintained" for some time; there's various projects that use the current release as a dependency as part of LTS branches. Moving those LTS branches to a new major release is not without consequences.

@milosgajdos
Copy link
Member

for the module, we may have to consider keeping the branch "maintained" for some time

I see what you mean here but I do not like the idea of this at all - ideally we gently "force" people to migrate to v3 otherwise they won't do a thing - that's my general professional experience, not necessarily related to this project

Copy link
Collaborator

@wy65701436 wy65701436 left a comment

Choose a reason for hiding this comment

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

lgtm

@milosgajdos milosgajdos merged commit 5d5c60f into distribution:release/2.8 Jan 11, 2024
3 checks passed
@thaJeztah thaJeztah deleted the 2.8_backport_deprecate_ReadSeekCloser branch January 11, 2024 07:51
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.

None yet

3 participants