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

Upgrading broken due to vanity rename #464

Closed
andig opened this issue Aug 10, 2024 · 4 comments
Closed

Upgrading broken due to vanity rename #464

andig opened this issue Aug 10, 2024 · 4 comments
Labels

Comments

@andig
Copy link

andig commented Aug 10, 2024

From #462:

This will create easily solved breakage on updates but I figure it's best to pull the band aid off as early as possible

They are easily resolvable only by adding replace directives afaikt, at least if downstream modules depend on it. As a result, this will break everybody's go.mod and will make everybody wait for downstream updates. There is no obvious reason for pulling of the "band aid".

It would imho have been much better to not update the module name. Given it is a vanity name anyway there's absolutely no need for doing so. If a rename is needed it should be for a new start instead of breaking the vanity import.

I'd suggest to retract this version and decide either way. The current solution is the worst possible. At least the vanity import should continue forwarding to the old repo.

@coder-labeler coder-labeler bot added the bug label Aug 10, 2024
@nhooyr
Copy link
Contributor

nhooyr commented Aug 10, 2024

Great point @andig

Sorry for the trouble. Here's what we changed in response:

nhooyr.io/websocket now points to https://github.com/nhooyr/websocket-old/releases/tag/v1.8.16 which is marked as deprecated at the package level & all exported symbols so that people know to transition off it.

There will be no further updates or breakage on nhooyr.io/websocket

github.com/coder/websocket is an entirely separate module now.

Thanks for opening the issue.

@nhooyr
Copy link
Contributor

nhooyr commented Aug 10, 2024

@andig
Copy link
Author

andig commented Aug 11, 2024

Thank you. Did a quick go get -u:

go: upgraded nhooyr.io/websocket v1.8.11 => v1.8.17

This seems great, especially since https://nhooyr.io/websocket points to Coder now. Thank you for changing this so quickly and making developer's life a bit easier!

@mafredri
Copy link
Member

Thanks for handling this so quickly @nhooyr and @andig I'm glad this works more conveniently now. Closing, but feel free to re-open if there are still any issues remaining.

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

No branches or pull requests

3 participants