socket.io-client-swift icon indicating copy to clipboard operation
socket.io-client-swift copied to clipboard

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

Open TysonAndre opened this issue 4 years ago • 1 comments

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

TysonAndre avatar Mar 02 '21 19:03 TysonAndre

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?

nuclearace avatar Mar 03 '21 14:03 nuclearace