From d0b46de7ce7f7ef55a164f432da345891ad2d2a2 Mon Sep 17 00:00:00 2001 From: Francis Charette Migneault Date: Tue, 24 Oct 2023 15:11:23 -0400 Subject: [PATCH 1/2] fix async/await calls for CustomDockerSpawner.start --- CHANGES.md | 8 +++++++- birdhouse/config/jupyterhub/jupyterhub_config.py.template | 4 ++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index eb49d696d..45ceba1dc 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -15,7 +15,13 @@ [Unreleased](https://github.com/bird-house/birdhouse-deploy/tree/master) (latest) ------------------------------------------------------------------------------------------------------------------ -[//]: # (list changes here, using '-' for each new entry, remove this when items are added) +## Fixes + +- Fix warning from JupyterHub regarding DockerSpawner method never awaited. + - [`DockerSpawner.start`]( + https://github.com/jupyterhub/dockerspawner/blob/a6bf72e7/dockerspawner/dockerspawner.py#L1246) is defined + as `async`. Therefore, `async def` and `await super().start()` where not properly invoked by `CustomDockerSpawner` + in [`jupyterhub_config.py.template`](./birdhouse/config/jupyterhub/jupyterhub_config.py.template). [1.35.1](https://github.com/bird-house/birdhouse-deploy/tree/1.35.1) (2023-10-18) ------------------------------------------------------------------------------------------------------------------ diff --git a/birdhouse/config/jupyterhub/jupyterhub_config.py.template b/birdhouse/config/jupyterhub/jupyterhub_config.py.template index 909e6d5a6..ace339e2f 100644 --- a/birdhouse/config/jupyterhub/jupyterhub_config.py.template +++ b/birdhouse/config/jupyterhub/jupyterhub_config.py.template @@ -23,7 +23,7 @@ c.JupyterHub.db_url = '/persist/jupyterhub.sqlite' c.JupyterHub.template_paths = ['/custom_templates'] class CustomDockerSpawner(DockerSpawner): - def start(self): + async def start(self): if(os.environ['MOUNT_IMAGE_SPECIFIC_NOTEBOOKS'] == 'true'): host_dir = join(os.environ['JUPYTERHUB_USER_DATA_DIR'], 'tutorial-notebooks-specific-images') @@ -50,7 +50,7 @@ class CustomDockerSpawner(DockerSpawner): "bind": "/notebook_dir/tutorial-notebooks", "mode": "ro" } - return super().start() + return await super().start() c.JupyterHub.spawner_class = CustomDockerSpawner From ff420e12ddf29c22cb3a815c9d2e12c9f71456a8 Mon Sep 17 00:00:00 2001 From: Francis Charette Migneault Date: Tue, 24 Oct 2023 17:05:12 -0400 Subject: [PATCH 2/2] =?UTF-8?q?Bump=20version:=201.35.1=20=E2=86=92=201.35?= =?UTF-8?q?.2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 6 +++--- CHANGES.md | 5 +++++ Makefile | 2 +- README.rst | 8 ++++---- RELEASE.txt | 2 +- .../config/canarie-api/docker_configuration.py.template | 8 ++++---- docs/source/conf.py | 4 ++-- 7 files changed, 20 insertions(+), 15 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index a3a4d7325..6a891f405 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.35.1 +current_version = 1.35.2 commit = True tag = False tag_name = {new_version} @@ -30,11 +30,11 @@ search = {current_version} replace = {new_version} [bumpversion:file:RELEASE.txt] -search = {current_version} 2023-10-18T12:50:38Z +search = {current_version} 2023-10-24T21:05:12Z replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ} [bumpversion:part:releaseTime] -values = 2023-10-18T12:50:38Z +values = 2023-10-24T21:05:12Z [bumpversion:file(version):birdhouse/config/canarie-api/docker_configuration.py.template] search = 'version': '{current_version}' diff --git a/CHANGES.md b/CHANGES.md index 45ceba1dc..39d5641d6 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -15,6 +15,11 @@ [Unreleased](https://github.com/bird-house/birdhouse-deploy/tree/master) (latest) ------------------------------------------------------------------------------------------------------------------ +[//]: # (list changes here, using '-' for each new entry, remove this when items are added) + +[1.35.2](https://github.com/bird-house/birdhouse-deploy/tree/1.35.2) (2023-10-24) +------------------------------------------------------------------------------------------------------------------ + ## Fixes - Fix warning from JupyterHub regarding DockerSpawner method never awaited. diff --git a/Makefile b/Makefile index 97f9e1c69..3a0c8b088 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # Generic variables override SHELL := bash override APP_NAME := birdhouse-deploy -override APP_VERSION := 1.35.1 +override APP_VERSION := 1.35.2 # utility to remove comments after value of an option variable override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g") diff --git a/README.rst b/README.rst index 726d37736..11c624c43 100644 --- a/README.rst +++ b/README.rst @@ -14,13 +14,13 @@ for a full-fledged production platform. * - releases - | |latest-version| |commits-since| -.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.35.1.svg +.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.35.2.svg :alt: Commits since latest release - :target: https://github.com/bird-house/birdhouse-deploy/compare/1.35.1...master + :target: https://github.com/bird-house/birdhouse-deploy/compare/1.35.2...master -.. |latest-version| image:: https://img.shields.io/badge/tag-1.35.1-blue.svg?style=flat +.. |latest-version| image:: https://img.shields.io/badge/tag-1.35.2-blue.svg?style=flat :alt: Latest Tag - :target: https://github.com/bird-house/birdhouse-deploy/tree/1.35.1 + :target: https://github.com/bird-house/birdhouse-deploy/tree/1.35.2 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest :alt: ReadTheDocs Build Status (latest version) diff --git a/RELEASE.txt b/RELEASE.txt index 4cebb9095..ffc626699 100644 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -1 +1 @@ -1.35.1 2023-10-18T12:50:38Z +1.35.2 2023-10-24T21:05:12Z diff --git a/birdhouse/config/canarie-api/docker_configuration.py.template b/birdhouse/config/canarie-api/docker_configuration.py.template index aa6dfb9ec..9c206d08e 100644 --- a/birdhouse/config/canarie-api/docker_configuration.py.template +++ b/birdhouse/config/canarie-api/docker_configuration.py.template @@ -109,8 +109,8 @@ SERVICES = { # NOTE: # Below version and release time auto-managed by 'make VERSION=x.y.z bump'. # Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'. - 'version': '1.35.1', - 'releaseTime': '2023-10-18T12:50:38Z', + 'version': '1.35.2', + 'releaseTime': '2023-10-24T21:05:12Z', 'institution': 'Ouranos', 'researchSubject': 'Climatology', 'supportEmail': '${SUPPORT_EMAIL}', @@ -142,8 +142,8 @@ PLATFORMS = { # NOTE: # Below version and release time auto-managed by 'make VERSION=x.y.z bump'. # Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'. - 'version': '1.35.1', - 'releaseTime': '2023-10-18T12:50:38Z', + 'version': '1.35.2', + 'releaseTime': '2023-10-24T21:05:12Z', 'institution': 'Ouranos', 'researchSubject': 'Climatology', 'supportEmail': '${SUPPORT_EMAIL}', diff --git a/docs/source/conf.py b/docs/source/conf.py index 770c16865..2fb240538 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -69,9 +69,9 @@ # built documents. # # The short X.Y version. -version = '1.35.1' +version = '1.35.2' # The full version, including alpha/beta/rc tags. -release = '1.35.1' +release = '1.35.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.