From 055bd35bd675a6392f4162c9782d5da9332efbec Mon Sep 17 00:00:00 2001 From: mishaschwartz <4380924+mishaschwartz@users.noreply.github.com> Date: Thu, 14 Dec 2023 12:22:57 -0500 Subject: [PATCH 1/2] make cowbird README enabled by default --- CHANGES.md | 9 ++++++++- birdhouse/components/cowbird/default.env | 4 +++- birdhouse/components/jupyterhub/default.env | 5 ----- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index ee876827..6ee4b40c 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -15,7 +15,14 @@ [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 + +- Cowbird README file disappears now that cowbird is a default component + + The settings to enable the Cowbird README file (added in version 1.41.0) assumed that the cowbird component would + be loaded after the juptyerhub component. Now that the cowbird component is part of the `DEFAULT_CONF_DIRS` and + therefore will always be loaded first, this updates the settings so that the README file will be enabled given the new + component load order. [2.0.1](https://github.com/bird-house/birdhouse-deploy/tree/2.0.1) (2023-12-11) ------------------------------------------------------------------------------------------------------------------ diff --git a/birdhouse/components/cowbird/default.env b/birdhouse/components/cowbird/default.env index e1772b4b..eed5df5f 100644 --- a/birdhouse/components/cowbird/default.env +++ b/birdhouse/components/cowbird/default.env @@ -50,7 +50,9 @@ export COWBIRD_LOG_LEVEL=INFO # Subdirectory of DATA_PERSIST_SHARED_ROOT containing the user workspaces used by Cowbird export USER_WORKSPACES="user_workspaces" -# Use Cowbird's own readme file, if a readme was not already defined. +# Path to the README.ipynb for welcoming and guiding new users to Jupyterhub. +# If this path is changed, users will have to restart their personal Jupyter +# server for the change to take effect. # This file explains the workspace to the user when using Cowbird. # Note that the variable can still be overriden by the `env.local` file. export JUPYTERHUB_COWBIRD_README="$COMPOSE_DIR/components/cowbird/user_workspace_readme.ipynb" diff --git a/birdhouse/components/jupyterhub/default.env b/birdhouse/components/jupyterhub/default.env index 93c6132a..6b746cf2 100644 --- a/birdhouse/components/jupyterhub/default.env +++ b/birdhouse/components/jupyterhub/default.env @@ -38,11 +38,6 @@ export JUPYTER_DEMO_USER_CPU_LIMIT="0.5" # 50% of 1 CPU export JUPYTER_LOGIN_BANNER_TOP_SECTION="" export JUPYTER_LOGIN_BANNER_BOTTOM_SECTION="" -# Path to the README.ipynb for welcoming and guiding new users to Jupyterhub. -# If this path is changed, users will have to restart their personal Jupyter -# server for the change to take effect. -export JUPYTERHUB_README="" - # Timeout (in seconds, default: 3 days) to shut down the user server when no kernels or terminals # are running and there is no activity. If undefined or set to zero, the feature will not be enabled. export JUPYTER_IDLE_SERVER_CULL_TIMEOUT=259200 From d414731f893ce5ee7b0d865fb660d1fb159c4e0a Mon Sep 17 00:00:00 2001 From: mishaschwartz <4380924+mishaschwartz@users.noreply.github.com> Date: Fri, 15 Dec 2023 12:42:58 -0500 Subject: [PATCH 2/2] =?UTF-8?q?Bump=20version:=202.0.1=20=E2=86=92=202.0.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 +- .../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 b98a4c20..97ca9eac 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.0.1 +current_version = 2.0.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-12-11T22:30:20Z +search = {current_version} 2023-12-15T17:42:58Z replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ} [bumpversion:part:releaseTime] -values = 2023-12-11T22:30:20Z +values = 2023-12-15T17:42:58Z [bumpversion:file(version):birdhouse/components/canarie-api/docker_configuration.py.template] search = 'version': '{current_version}' diff --git a/CHANGES.md b/CHANGES.md index 6ee4b40c..b6682271 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) + +[2.0.2](https://github.com/bird-house/birdhouse-deploy/tree/2.0.2) (2023-12-15) +------------------------------------------------------------------------------------------------------------------ + ## Fixes - Cowbird README file disappears now that cowbird is a default component diff --git a/Makefile b/Makefile index 82997cab..4bc5d908 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # Generic variables override SHELL := bash override APP_NAME := birdhouse-deploy -override APP_VERSION := 2.0.1 +override APP_VERSION := 2.0.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 11bfffdb..b3290151 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/2.0.1.svg +.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.0.2.svg :alt: Commits since latest release - :target: https://github.com/bird-house/birdhouse-deploy/compare/2.0.1...master + :target: https://github.com/bird-house/birdhouse-deploy/compare/2.0.2...master -.. |latest-version| image:: https://img.shields.io/badge/tag-2.0.1-blue.svg?style=flat +.. |latest-version| image:: https://img.shields.io/badge/tag-2.0.2-blue.svg?style=flat :alt: Latest Tag - :target: https://github.com/bird-house/birdhouse-deploy/tree/2.0.1 + :target: https://github.com/bird-house/birdhouse-deploy/tree/2.0.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 99eb908c..fe467292 100644 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -1 +1 @@ -2.0.1 2023-12-11T22:30:20Z +2.0.2 2023-12-15T17:42:58Z diff --git a/birdhouse/components/canarie-api/docker_configuration.py.template b/birdhouse/components/canarie-api/docker_configuration.py.template index 3e70d273..925f465f 100644 --- a/birdhouse/components/canarie-api/docker_configuration.py.template +++ b/birdhouse/components/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': '2.0.1', - 'releaseTime': '2023-12-11T22:30:20Z', + 'version': '2.0.2', + 'releaseTime': '2023-12-15T17:42:58Z', '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': '2.0.1', - 'releaseTime': '2023-12-11T22:30:20Z', + 'version': '2.0.2', + 'releaseTime': '2023-12-15T17:42:58Z', 'institution': 'Ouranos', 'researchSubject': 'Climatology', 'supportEmail': '${SUPPORT_EMAIL}', diff --git a/docs/source/conf.py b/docs/source/conf.py index 30889a14..7318b5cd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -69,9 +69,9 @@ # built documents. # # The short X.Y version. -version = '2.0.1' +version = '2.0.2' # The full version, including alpha/beta/rc tags. -release = '2.0.1' +release = '2.0.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.