Cowbird README file disappears now that cowbird is a default component (

#412)

## Overview

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.

## Changes

**Non-breaking changes**
- Fixes a bug

**Breaking changes**

## Related Issue / Discussion

## Additional Information

<!--
The test suite can be run using a different DACCS config with
``birdhouse_daccs_configs_branch: branch_name`` in the PR description.
To globally skip the test suite regardless of the commit message use
``birdhouse_skip_ci: true`` in the PR description.
-->

birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false

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

CHANGES.md

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

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

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)

RELEASE.txt

@@ -1 +1 @@
-2.0.1 2023-12-11T22:30:20Z
+2.0.2 2023-12-15T17:42:58Z

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

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"

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

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.