novnc
Announce breaking changes
Is your feature request related to a problem? Please describe. The path to the websockify executable has changed without further notice, introducing a breaking change.
Describe the solution you'd like Announce breaking changes somewhere for people to see, instead of hiding them in the diffs.
Additional context
I was just debugging this popular error code of noVNC: Failed when connecting: Connection closed (code: 1006). Took me a few hours, reconfiguring my VNC servers, my VNC clients, my proxies, my reverse proxies, basically every piece of software before I found out there was an unannounced breaking change hiding in the documentation, that I found here: https://github.com/novnc/noVNC/wiki/Advanced-usage/_compare/aadf3b85fa50190cb789f88268fcc842dd625e27...32355360c589bed67a399e66618b3c611d983a80
→ The path noVNC/utils/websockify/websockify.py has been changed to noVNC/utils/websockify/run. -.-
Took me a while to realise how and why the websockify.py has disappeared.
Would be great if breaking changes like these could be documented more prominently in a "breaking changes" section inside the README.md.
What's bothering me even more is that the websockify repository has a CHANGES.txt, but this breaking change isn't mentioned there either.
I moved this issue to the novnc/websockify repo.
Agreed, that this would be nice. We don't have any release instructions for websockify, so let's keep this issue open until it's time for the next release; hopefully we'll remember.
