fix async/await calls for CustomDockerSpawner.start (#395)

## Overview

Fix `jupyterhub` async warning.

List any dependencies that are required for this change.

## Changes

**Non-breaking changes**
- 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).

**Breaking changes**
- n/a

.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}'

CHANGES.md

@@ -17,6 +17,17 @@
 
 [//]: # (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.
+  - [`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)
 ------------------------------------------------------------------------------------------------------------------
 

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")

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)

RELEASE.txt

@@ -1 +1 @@
-1.35.1 2023-10-18T12:50:38Z
+1.35.2 2023-10-24T21:05:12Z

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}',

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
 

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.