Update definition against upstream https://github.com/jupyterhub/jupyter-remote-desktop-proxy

(and correct for issue jupyterhub/jupyter-remote-desktop-proxy#47)

Author: willend

dmsc-summerschool-2023/CHANGELOG.md

@@ -1,13 +1,113 @@
-# 0.1.2
+# Changelog
+
+## v1.1 - 2023-07-18
+
+### v1.0...v1.1
+
+([full changelog](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v1.0...v1.1))
+
+#### Enhancements made
+
+- Add logic to determine if vncserver is TigerVNC [#32](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/32) ([@cmd-ntrf](https://github.com/cmd-ntrf))
+
+#### Bugs fixed
+
+- Fix path when using bundled tigervnc [#44](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/44) ([@pnasrat](https://github.com/pnasrat))
+- Remove hardcoded display number and port, avoids multi-user conflicts [#34](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/34) ([@cmd-ntrf](https://github.com/cmd-ntrf))
+
+#### Maintenance and upkeep improvements
+
+- Add RELEASE.md, adopt tbump, rename release workflow for consistency [#38](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/38) ([@consideRatio](https://github.com/consideRatio))
+- Remove "/usr/bin" prefix in front of dbus-launch in xstartup [#33](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/33) ([@cmd-ntrf](https://github.com/cmd-ntrf))
+- Add logic to determine if vncserver is TigerVNC [#32](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/32) ([@cmd-ntrf](https://github.com/cmd-ntrf))
+- dependabot: monthly updates of github actions [#30](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/30) ([@consideRatio](https://github.com/consideRatio))
+- maint: add pre-commit config [#25](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/25) ([@consideRatio](https://github.com/consideRatio))
+- Quieten binder-badge bot [#3](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/3) ([@manics](https://github.com/manics))
+
+#### Documentation improvements
+
+- Add PyPI/Issues/Forum badges for readme [#40](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/40) ([@consideRatio](https://github.com/consideRatio))
+- Backfill changelog for 1.0.0 and 0.1.3 [#37](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/37) ([@consideRatio](https://github.com/consideRatio))
+
+#### Other merged PRs
+
+- Fix permissions required for trusted workflow [#48](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/48) ([@yuvipanda](https://github.com/yuvipanda))
+- Use trusted publishing to push to PyPI [#46](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/46) ([@yuvipanda](https://github.com/yuvipanda))
+- [pre-commit.ci] pre-commit autoupdate [#42](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/42) ([@pre-commit-ci](https://github.com/pre-commit-ci))
+- ci: fix typo in manics/action-binderbadge version [#39](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/39) ([@consideRatio](https://github.com/consideRatio))
+- Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6 [#36](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/36) ([@dependabot](https://github.com/dependabot))
+- Bump pypa/gh-action-pypi-publish from 1.6.4 to 1.8.5 [#31](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/31) ([@dependabot](https://github.com/dependabot))
+- [pre-commit.ci] pre-commit autoupdate [#28](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/28) ([@pre-commit-ci](https://github.com/pre-commit-ci))
+
+#### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/graphs/contributors?from=2023-01-19&to=2023-07-18&type=c))
+
+[@cmd-ntrf](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Acmd-ntrf+updated%3A2023-01-19..2023-07-18&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3AconsideRatio+updated%3A2023-01-19..2023-07-18&type=Issues) | | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Amanics+updated%3A2023-01-19..2023-07-18&type=Issues) | [@pnasrat](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Apnasrat+updated%3A2023-01-19..2023-07-18&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Ayuvipanda+updated%3A2023-01-19..2023-07-18&type=Issues)
+
+## v1.0.0 - 2023-01-19
+
+With this release, the project has relocated from `jupyter-desktop-server` to
+`jupyter-remote-desktop-proxy` and relocated from
+[yuvipanda/jupyter-desktop-server](https://github.com/yuvipanda/jupyter-desktop-server) to
+[jupyterhub/jupyter-remote-desktop-proxy](https://github.com/jupyterhub/jupyter-remote-desktop-proxy).
+
+### New features added
+
+- Add a shared clipboard [#10](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/10) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda), [@satra](https://github.com/satra), [@fperez](https://github.com/fperez))
+
+### Enhancements made
+
+- Use TurboVNC if installed [#29 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/29) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda), [@cslocum](https://github.com/cslocum))
+
+### Maintenance and upkeep improvements
+
+- maint: add dependabot for github actions [#22](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/22) ([@consideRatio](https://github.com/consideRatio), [@yuvipanda](https://github.com/yuvipanda))
+- Complete rename of the project - from jupyter_desktop/jupyter-desktop-server to jupyter_remote_desktop_proxy [#20](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/20) ([@yuvipanda](https://github.com/yuvipanda), [@consideRatio](https://github.com/consideRatio))
+- Remove apt.txt and refactor Dockerfile [#13](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/13) ([@consideRatio](https://github.com/consideRatio), [@yuvipanda](https://github.com/yuvipanda), [@manics](https://github.com/manics))
+- Update TurboVNC to 2.2.6 [#11](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/11) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio))
+- Update noVNC to 1.2.0 [#6](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/6) ([@manics](https://github.com/manics))
+- Add setup.py metadata [#5](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/5) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda))
+- Add pypi publish workflow [#4](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/4) ([@manics](https://github.com/manics))
+- Rename repo jupyter-desktop-server ➡️ jupyter-remote-desktop-proxy [#2](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/2) ([@manics](https://github.com/manics), [@choldgraf](https://github.com/choldgraf))
+- Fix permissions on ~/.cache [#22 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/22) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda), [@djangoliv](https://github.com/djangoliv), [@nthiery](https://github.com/nthiery))
+- Use conda-forge/websockify, use environment.yml in Dockerfile [#21 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/21) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda))
+
+### Documentation improvements
+
+- Fix typo [#24](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/24) ([@yuvipanda](https://github.com/yuvipanda), [@consideRatio](https://github.com/consideRatio))
+- Add installation instructions [#21](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/21) ([@yuvipanda](https://github.com/yuvipanda), [@consideRatio](https://github.com/consideRatio))
+- Add a section on limitations - OpenGL is currently not supported [#19](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/19) ([@yuvipanda](https://github.com/yuvipanda), [@consideRatio](https://github.com/consideRatio))
+
+### Continuous integration improvements
+
+- ci: update outdated github actions [#23](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/23) ([@consideRatio](https://github.com/consideRatio), [@yuvipanda](https://github.com/yuvipanda))
+- binder-badge workflow needs permissions.pull-requests:write [#9](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/9) ([@manics](https://github.com/manics))
+- binder-badge workflow needs permissions.issues:write [#8](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/8) ([@manics](https://github.com/manics))
+- Add binder-badge.yaml [#23 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/23) ([@manics](https://github.com/manics), [@yuvipanda](https://github.com/yuvipanda))
+
+## v0.1.3 - 2020-07-07
+
+- add Dockerfile and adjust readme to reflect a quick start [#19 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/19) ([@kniec](https://github.com/kniec), [@yuvipanda](https://github.com/yuvipanda))
+- Start session from $HOME [#17 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/17) ([@mjuric](https://github.com/mjuric), [@yuvipanda](https://github.com/yuvipanda))
+- add Dockerfile and adjust readme to reflect a quick start [#19 (in previous github repo)](https://github.com/yuvipanda/jupyter-desktop-server/pull/19) ([@kniec](https://github.com/kniec), [@yuvipanda](https://github.com/yuvipanda))
+- Support jupyter-server-proxy >= 1.4.0 [daecbdb](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/commit/daecbdb) ([@yuvipanda](https://github.com/yuvipanda))
+- Revert "Add a jupyter server extension to render desktop/" [b6dee24](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/commit/b6dee24) ([@yuvipanda](https://github.com/yuvipanda))
+- Add a jupyter server extension to render desktop/ [18d7fb7](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/commit/18d7fb7) ([@yuvipanda](https://github.com/yuvipanda))
+- Fix README to point to new name [bda9a7e](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/commit/bda9a7e) ([@yuvipanda](https://github.com/yuvipanda))
+- Explicitly specify version of jupyter-server-proxy needed [98b7723](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/commit/98b7723) ([@yuvipanda](https://github.com/yuvipanda))
+- Set CWD of desktop environment to CWD of notebook [360f9b0](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/commit/360f9b0) ([@yuvipanda](https://github.com/yuvipanda))
+
+## v0.1.2 - 2019-11-12
 
 - Fix cross-origin issue in Safari (#9, thanks to @eslavich)
 
-# 0.1.1
+## v0.1.1 - 2019-11-06
 
 - Increase default resolution to 1680x1050. The wider screen
   matches how many user displays are, and there do not seem to
   be lag issues.
 
-# 0.1
+## v0.1 - 2019-11-01
 
 - Initial release

dmsc-summerschool-2023/Dockerfile

@@ -1,10 +1,12 @@
-FROM jupyter/base-notebook:4d70cf8da953
+FROM docker.io/jupyter/base-notebook:4d70cf8da953
 
 
 USER root
 
-# get McCode debian packages: release release 3.3
-RUN  wget http://packages.mccode.org/debian/dists/stable/main/binary-amd64/mcstas-3.3-deb64.deb \
+# update/upgrade and get McCode debian packages: release release 3.3
+RUN apt-get -y -q update \
+ && apt-get -y -q upgrade \
+&&   wget http://packages.mccode.org/debian/dists/stable/main/binary-amd64/mcstas-3.3-deb64.deb \
 &&   wget http://packages.mccode.org/debian/dists/stable/main/binary-amd64/mcstas-comps-3.3-deb64.deb \
 &&   wget http://packages.mccode.org/debian/dists/stable/main/binary-amd64/mcstas-manuals-3.3-deb64.deb \
 &&   wget http://packages.mccode.org/debian/dists/stable/main/binary-amd64/mcstas-tools-matlab-mcplot-3.3-deb64.deb \
@@ -50,12 +52,14 @@ RUN  wget http://packages.mccode.org/debian/dists/stable/main/binary-amd64/mcsta
 RUN apt install -y ./*.deb && rm *.deb && ln -s /opt/conda /usr/share/mcstas/3.3/miniconda3
 
 
-# Remove light-locker to prevent screen lock
-RUN wget 'https://sourceforge.net/projects/turbovnc/files/2.2.5/turbovnc_2.2.5_amd64.deb/download' -O turbovnc_2.2.5_amd64.deb && \
-   apt-get install -y -q ./turbovnc_2.2.5_amd64.deb && \
-   apt-get remove -y -q light-locker xfce4-screensaver && \
-   rm ./turbovnc_2.2.5_amd64.deb && \
-   ln -s /opt/TurboVNC/bin/* /usr/local/bin/
+# Install TurboVNC (https://github.com/TurboVNC/turbovnc)
+ARG TURBOVNC_VERSION=2.2.6
+RUN wget -q "https://sourceforge.net/projects/turbovnc/files/${TURBOVNC_VERSION}/turbovnc_${TURBOVNC_VERSION}_amd64.deb/download" -O turbovnc.deb \
+ && apt-get install -y -q ./turbovnc.deb \
+    # remove light-locker to prevent screen lock
+ && apt-get remove -y -q light-locker xfce4-screensaver \
+ && rm ./turbovnc.deb \
+ && ln -s /opt/TurboVNC/bin/* /usr/local/bin/
 
 # apt-get may result in root-owned directories/files under $HOME
 RUN chown -R $NB_UID:$NB_GID $HOME

dmsc-summerschool-2023/LICENSE

@@ -26,4 +26,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dmsc-summerschool-2023/MANIFEST.in

@@ -1 +1 @@
-graft jupyter_desktop/share
+graft jupyter_remote_desktop_proxy/share

dmsc-summerschool-2023/README.md

@@ -5,19 +5,19 @@ Container with software packages for use in the course https://indico.esss.lu.se
 ([JupyterLab](https://jupyter.org), [scipp](https://scipp.github.io),
 [NeXus format](https://www.nexusformat.org), [McStas](https://mcstas.org) and more)
 
-**Currrent revision: 1.3** (built 20230817)
+**Currrent revision: 1.4** (built 20230818)
 
 This Docker recipe can be used to build the supporting container, e.g.
 
 Build via e.g.
 ```
-podman build . --format=docker -t docker.io/mccode/dmsc-summerschool:1.3
+podman build . --format=docker -t docker.io/mccode/dmsc-summerschool:1.4
 ```
 Will be (manually) uploaded to DockerHub by Peter on changes.
 
 Run via e.g.
 ```
-podman run -p8888:8888 docker.io/mccode/dmsc-summerschool:1.3
+podman run -p8888:8888 docker.io/mccode/dmsc-summerschool:1.4
 ```
 
 ## Credits

dmsc-summerschool-2023/RELEASE.md

@@ -0,0 +1,53 @@
+# How to make a release
+
+`jupyter-remote-desktop-proxy` is a package available on [PyPI].
+
+These are the instructions on how to make a release.
+
+## Pre-requisites
+
+- Push rights to this GitHub repository
+
+## Steps to make a release
+
+1. Create a PR updating `CHANGELOG.md` with [github-activity] and continue when
+   its merged.
+
+   Advice on this procedure can be found in [this team compass
+   issue](https://github.com/jupyterhub/team-compass/issues/563).
+
+2. Checkout main and make sure it is up to date.
+
+   ```shell
+   git checkout main
+   git fetch origin main
+   git reset --hard origin/main
+   ```
+
+3. Update the version, make commits, and push a git tag with `tbump`.
+
+   ```shell
+   pip install tbump
+   ```
+
+   `tbump` will ask for confirmation before doing anything.
+
+   ```shell
+   # Example versions to set: 1.0.0, 1.0.0b1
+   VERSION=
+   tbump ${VERSION}
+   ```
+
+   Following this, the [CI system] will build and publish a release.
+
+4. Reset the version back to dev, e.g. `1.0.1.dev` after releasing `1.0.0`.
+
+   ```shell
+   # Example version to set: 1.0.1.dev
+   NEXT_VERSION=
+   tbump --no-tag ${NEXT_VERSION}.dev
+   ```
+
+[github-activity]: https://github.com/executablebooks/github-activity
+[pypi]: https://pypi.org/project/jupyter-remote-desktop-proxy/
+[ci system]: https://github.com/jupyterhub/jupyter-remote-desktop-proxy/actions/workflows/release.yaml