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

Idea: Improve release notes for 16.x (Link to upgrading notes?) #1336

Open
TysonAndre opened this issue Mar 2, 2021 · 1 comment
Open

Idea: Improve release notes for 16.x (Link to upgrading notes?) #1336

TysonAndre opened this issue Mar 2, 2021 · 1 comment

Comments

@TysonAndre
Copy link
Contributor

https://github.com/socketio/socket.io-client-swift/releases seems to have tags instead of github releases for the latest stable version 16 releases - I only briefly looked and can't tell if this is deliberate.

It would be useful to link to https://nuclearace.github.io/Socket.IO-Client-Swift/15to16.html in the release notes for 16.0.0, for example, as well as from CHANGELOG.md - otherwise, it's easy to miss. https://github.com/socketio/socket.io-client-swift/blob/master/CHANGELOG.md#v1600

It seems like a 16.0.1 release was published but there are no release notes in CHANGELOG.md, unrelatedly - https://github.com/socketio/socket.io-client-swift/releases/tag/v16.0.1 mentions some changes in the linked commit description

For https://github.com/socketio/socket.io-client-swift#features it may be useful to clarify the version 2 comment by linking to https://nuclearace.github.io/Socket.IO-Client-Swift/15to16.html for .version(.two) (e.g. hyperlink) or mentioning that the version must be specified when connecting

@nuclearace
Copy link
Member

Thanks for the suggestions! I agree that the release process should be improved a bit...

For https://github.com/socketio/socket.io-client-swift#features it may be useful to clarify the version 2 comment by linking to https://nuclearace.github.io/Socket.IO-Client-Swift/15to16.html for .version(.two) (e.g. hyperlink) or mentioning that the version must be specified when connecting

Yes, that would probably be helpful. Would you want to PR that?

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

No branches or pull requests

2 participants