Cowbird README file disappears now that cowbird is a default component

[mishaschwartz]

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

birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false

[crim-jenkins-bot]

E2E Test Results

DACCS-iac Pipeline Results

Build URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/2365/
Result : success

BIRDHOUSE_DEPLOY_BRANCH : cowbird-readme-enable-fix
DACCS_CONFIGS_BRANCH : master
PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master
PAVICS_SDI_BRANCH : master

DESTROY_INFRA_ON_EXIT : true
PAVICS_HOST : https://host-140-20.rdext.crim.ca

PAVICS-e2e-workflow-tests Pipeline Results

Tests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/1481/

NOTEBOOK TEST RESULTS

    
[2023-12-14T17:38:28.241Z] ============================= test session starts ==============================
[2023-12-14T17:38:28.241Z] platform linux -- Python 3.9.16, pytest-7.3.1, pluggy-1.0.0
[2023-12-14T17:38:28.242Z] rootdir: /home/jenkins/agent/workspace/PAVICS-e2e-workflow-tests_master
[2023-12-14T17:38:28.242Z] plugins: anyio-3.6.1, dash-2.10.0, nbval-0.9.6, tornasync-0.6.0.post2, xdist-3.3.1
[2023-12-14T17:38:28.242Z] collected 265 items
[2023-12-14T17:38:28.242Z] 
[2023-12-14T17:38:38.359Z] notebooks-auth/geoserver.ipynb ..................                        [  6%]
[2023-12-14T17:39:13.085Z] notebooks-auth/test_cowbird_jupyter.ipynb ..........                     [ 10%]
[2023-12-14T17:39:17.600Z] notebooks-auth/test_thredds.ipynb ...........                            [ 14%]
[2023-12-14T17:39:26.168Z] pavics-sdi-master/docs/source/notebooks/WCS_example.ipynb .......        [ 17%]
[2023-12-14T17:39:36.247Z] pavics-sdi-master/docs/source/notebooks/WFS_example.ipynb ......         [ 19%]
[2023-12-14T17:39:42.948Z] pavics-sdi-master/docs/source/notebooks/WMS_example.ipynb ........       [ 22%]
[2023-12-14T17:47:25.236Z] pavics-sdi-master/docs/source/notebooks/climex.ipynb ............        [ 27%]
[2023-12-14T17:47:25.236Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-climate-stations.ipynb . [ 27%]
[2023-12-14T17:47:31.489Z] ...............                                                          [ 33%]
[2023-12-14T17:47:40.941Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-xclim.ipynb .....    [ 35%]
[2023-12-14T17:47:48.767Z] pavics-sdi-master/docs/source/notebooks/esgf-dap.ipynb ......            [ 37%]
[2023-12-14T17:48:05.538Z] pavics-sdi-master/docs/source/notebooks/forecasts.ipynb ......           [ 39%]
[2023-12-14T17:48:06.924Z] pavics-sdi-master/docs/source/notebooks/jupyter_extensions.ipynb .       [ 40%]
[2023-12-14T17:48:11.992Z] pavics-sdi-master/docs/source/notebooks/opendap.ipynb .......            [ 42%]
[2023-12-14T17:48:16.511Z] pavics-sdi-master/docs/source/notebooks/pavics_thredds.ipynb .....       [ 44%]
[2023-12-14T17:51:28.705Z] pavics-sdi-master/docs/source/notebooks/regridding.ipynb ............... [ 50%]
[2023-12-14T17:52:41.165Z] .............                                                            [ 55%]
[2023-12-14T17:52:43.359Z] pavics-sdi-master/docs/source/notebooks/rendering.ipynb ....             [ 56%]
[2023-12-14T17:52:45.579Z] pavics-sdi-master/docs/source/notebooks/subset-user-input.ipynb ........ [ 59%]
[2023-12-14T17:53:02.383Z] .................                                                        [ 66%]
[2023-12-14T17:53:10.286Z] pavics-sdi-master/docs/source/notebooks/subsetting.ipynb ......          [ 68%]
[2023-12-14T17:53:11.675Z] pavics-sdi-master/docs/source/notebook-components/weaver_example.ipynb . [ 68%]
[2023-12-14T17:53:29.769Z] .........                                                                [ 72%]
[2023-12-14T17:53:38.840Z] finch-master/docs/source/notebooks/dap_subset.ipynb ...........          [ 76%]
[2023-12-14T17:53:48.202Z] finch-master/docs/source/notebooks/finch-usage.ipynb ......              [ 78%]
[2023-12-14T17:53:49.590Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-1DataAccess.ipynb . [ 78%]
[2023-12-14T17:53:52.936Z] ......                                                                   [ 81%]
[2023-12-14T17:53:59.538Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-2Subsetting.ipynb . [ 81%]
[2023-12-14T17:54:16.285Z] .............                                                            [ 86%]
[2023-12-14T17:54:26.295Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-3Climate-Indicators.ipynb . [ 86%]
[2023-12-14T17:55:02.891Z] ....s.                                                                   [ 89%]
[2023-12-14T17:55:11.057Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-4Ensembles.ipynb . [ 89%]
[2023-12-14T17:55:25.859Z] ...                                                                      [ 90%]
[2023-12-14T17:55:40.788Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-5Visualization.ipynb . [ 90%]
[2023-12-14T17:56:03.087Z] ......                                                                   [ 93%]
[2023-12-14T17:56:05.378Z] notebooks/hummingbird.ipynb ............                                 [ 97%]
[2023-12-14T17:58:39.557Z] notebooks/stress-tests.ipynb ......                                      [100%]
[2023-12-14T17:58:39.557Z] 
[2023-12-14T17:58:39.557Z] ================= 264 passed, 1 skipped in 1208.39s (0:20:08) ==================
    
  

[fmigneault]

I believe Ouranos overrides JUPYTER_README.
It is possible that we might need to do something like

export JUPYTERHUB_COWBIRD_README="${JUPYTER_README:-$COMPOSE_DIR/components/cowbird/user_workspace_readme.ipynb}"

@tlvu Need to validate this on your end.

[mishaschwartz]

I believe Ouranos overrides JUPYTER_README.

That's fine, as long as they're overriding it in the env.local file, the updated value will be used

[tlvu]

I believe Ouranos overrides JUPYTER_README.

That's fine, as long as they're overriding it in the env.local file, the updated value will be used

Exact, we use env.local to override so we have the last word on this.