From 73514f0a55634ec074f5e4470749221e80cd74c6 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 18 Mar 2025 10:58:37 +0100 Subject: [PATCH 1/5] Add changelog for v3.0.0 --- CHANGELOG.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 60 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d8cd1822..44aacfac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,18 +1,73 @@ # Changelog -## v2.0.1 +## v3.0 -([full changelog](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v2.0.0...bec995c03f719fad2a37aa950842bc977eaae12e)) +### v3.0.0 - 2025-03-19 -### Bugs fixed +#### Breaking changes + +- TurboVNC version 3.1 or higher is now required ([#145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145)). +- This project no longer relies on `websockify` ([#119](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/119)). + +#### New features added + +- Override xstartup with environment variable `JUPYTER_REMOTE_DESKTOP_PROXY_XSTARTUP` [#134](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/134) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) + +#### Enhancements made + +- Access TurboVNC via a unix socket instead of a port [#145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145) ([@consideRatio](https://github.com/consideRatio), [@manics](https://github.com/manics)) +- Resize desktop to window, instead of scaling [#124](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/124) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda)) +- Close clipboard if clicked outside [#122](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/122) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda)) +- Remove websockify, add Playwright test [#119](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/119) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) + +#### Bugs fixed + +- Build and package JS built with webpack --mode production [#147](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/147) ([@consideRatio](https://github.com/consideRatio), [@manics](https://github.com/manics)) +- Pin @novnc/novnc 1.4.x pending 1.5.x compatibility [#120](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/120) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) + +#### Maintenance and upkeep improvements + +- Pin js dependency novnc to 1.5.0 until we support 1.6.0 [#142](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/142) ([@consideRatio](https://github.com/consideRatio)) +- Switch to date tag for base image, install nodejs [#136](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/136) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) +- Remove tigervnc-xorg-extension [#132](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/132) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) +- Update to use novnc 1.5.0 [#123](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/123) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda)) +- Rename tooltip to clipboard [#121](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/121) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) + +#### Continuous integration improvements + +- Pin dockerfile SHA, bump monthly with dependabot [#130](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/130) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) +- Install netcat-openbsd in tests and update screenshots for ubuntu 24.04 [#129](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/129) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) + +#### Other merged PRs + +This changelog entry omits automated PRs, for example those updating +dependencies in: images, github actions, pre-commit hooks. For a full list of +changes, see the [full comparison](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v2.0.1...v3.0.0). + +#### Contributors to this release + +The following people contributed discussions, new ideas, code and documentation contributions, and review. +See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports). + +([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/graphs/contributors?from=2024-06-13&to=2025-03-19&type=c)) + +@benz0li ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Abenz0li+updated%3A2024-06-13..2025-03-19&type=Issues)) | @consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3AconsideRatio+updated%3A2024-06-13..2025-03-19&type=Issues)) | @manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Amanics+updated%3A2024-06-13..2025-03-19&type=Issues)) | @yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Ayuvipanda+updated%3A2024-06-13..2025-03-19&type=Issues)) + +## v2.0 + +### v2.0.1 + +([full changelog](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v2.0.0...v2.0.1)) + +#### Bugs fixed - Retry a few times when the initial connection fails [#112](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/112) ([@sunu](https://github.com/sunu), [@yuvipanda](https://github.com/yuvipanda)) -### Other merged PRs +#### Other merged PRs - [pre-commit.ci] pre-commit autoupdate [#111](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/111) ([@consideRatio](https://github.com/consideRatio)) -### Contributors to this release +#### Contributors to this release The following people contributed discussions, new ideas, code and documentation contributions, and review. See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports). @@ -21,8 +76,6 @@ See [our definition of contributors](https://github-activity.readthedocs.io/en/l @consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3AconsideRatio+updated%3A2024-04-02..2024-06-13&type=Issues)) | @sunu ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Asunu+updated%3A2024-04-02..2024-06-13&type=Issues)) | @yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Ayuvipanda+updated%3A2024-04-02..2024-06-13&type=Issues)) -## v2.0 - ### v2.0.0 - 2024-04-02 This release removes a bundled VNC server, use of `jupyter-remote-desktop-proxy` From dd81df5b9c2ab88cf8b6cc7bd805097eff7fc7f5 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 18 Mar 2025 11:07:06 +0100 Subject: [PATCH 2/5] Move related novnc dependency PRs into a dependency updates category --- CHANGELOG.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 44aacfac..a38dafbf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,16 +23,19 @@ #### Bugs fixed - Build and package JS built with webpack --mode production [#147](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/147) ([@consideRatio](https://github.com/consideRatio), [@manics](https://github.com/manics)) -- Pin @novnc/novnc 1.4.x pending 1.5.x compatibility [#120](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/120) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) #### Maintenance and upkeep improvements -- Pin js dependency novnc to 1.5.0 until we support 1.6.0 [#142](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/142) ([@consideRatio](https://github.com/consideRatio)) - Switch to date tag for base image, install nodejs [#136](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/136) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) - Remove tigervnc-xorg-extension [#132](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/132) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) -- Update to use novnc 1.5.0 [#123](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/123) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda)) - Rename tooltip to clipboard [#121](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/121) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) +#### Dependency updates + +- Pin js dependency novnc to 1.5.0 until we support 1.6.0 [#142](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/142) ([@consideRatio](https://github.com/consideRatio)) +- Update to use novnc 1.5.0 [#123](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/123) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda)) +- Pin @novnc/novnc 1.4.x pending 1.5.x compatibility [#120](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/120) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) + #### Continuous integration improvements - Pin dockerfile SHA, bump monthly with dependabot [#130](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/130) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio)) From 5be6bafc437f05aae6e5b51b4271a313017cebf2 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 18 Mar 2025 11:38:40 +0100 Subject: [PATCH 3/5] Add a summary to the changelog entry --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a38dafbf..d334011e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,9 +4,15 @@ ### v3.0.0 - 2025-03-19 +VNC servers' accessed via this project are now consistently accessed via a unix +socket instead of a TCP port. Previously only TigerVNC was accessed via a unix +socket. With this change, any VNC server is suitable for use in environments +where different users share access to TCP ports. + #### Breaking changes - TurboVNC version 3.1 or higher is now required ([#145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145)). +- VNC servers needs to support the `-rfbunixpath` flag (TigerVNC and TurboVNC does) ([#145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145)). - This project no longer relies on `websockify` ([#119](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/119)). #### New features added From e2e254b0e5c02e6ac51da86bb9822d699755bf38 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 18 Mar 2025 22:11:36 +0100 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Simon Li --- CHANGELOG.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d334011e..3a9b898e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,10 +4,11 @@ ### v3.0.0 - 2025-03-19 -VNC servers' accessed via this project are now consistently accessed via a unix +VNC servers' accessed via this project must be accessed via a unix socket instead of a TCP port. Previously only TigerVNC was accessed via a unix -socket. With this change, any VNC server is suitable for use in environments -where different users share access to TCP ports. +socket. This change means jupyter-remote-desktop-proxy can be used in shared +environments as long as the file permissions on the unix socket restrict access +to a single user. TCP connections to the VNC server are no longer supported. #### Breaking changes From f82e7216edcf9e475e1e07007069c0c1c13ec600 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Sat, 22 Mar 2025 20:58:46 +0100 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Simon Li --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a9b898e..c5d84399 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## v3.0 -### v3.0.0 - 2025-03-19 +### v3.0.0 - 2025-03-22 VNC servers' accessed via this project must be accessed via a unix socket instead of a TCP port. Previously only TigerVNC was accessed via a unix