Add Docker image build (with repo2docker) and Continuous Delivery

Author: mfisher87

.github/workflows/build-and-publish-docker-image.yml

@@ -0,0 +1,59 @@
+name: "Build and push container image"
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "docker/*"
+      - ".github/workflows/build-and-publish-docker-image.yml"
+
+
+permissions:
+  contents: "read"
+  packages: "write"
+  attestations: "write"
+  id-token: "write"
+
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: false
+
+
+jobs:
+  build-and-push:
+    runs-on: "ubuntu-latest"
+    steps:
+
+    # For biggish images, github actions runs out of disk space.
+    # So we cleanup some unwanted things in the disk image, and reclaim that space for our docker use
+    # https://github.com/actions/virtual-environments/issues/2606#issuecomment-772683150
+    # and https://github.com/easimon/maximize-build-space/blob/b4d02c14493a9653fe7af06cc89ca5298071c66e/action.yml#L104
+    # This gives us a total of about 52G of free space, which should be enough for now
+    - name: "Cleanup disk space"
+      run: |
+        sudo rm -rf /usr/local/lib/android /usr/share/dotnet /opt/ghc
+        df -h
+
+    - name: "Checkout files in repo"
+      uses: "actions/checkout@v5"
+
+    - name: "Build and push the image"`
+      uses: "jupyterhub/repo2docker-action@master"
+      with:
+        REPO2DOCKER_EXTRA_ARGS: "--subdir docker"
+        DOCKER_USERNAME: "${{ github.repository_owner }}"
+        DOCKER_PASSWORD: "${{ secrets.GITHUB_TOKEN }}"
+        DOCKER_REGISTRY: "ghcr.io"
+        # Disable pushing a 'latest' tag, as this often just causes confusion
+        # LATEST_TAG_OFF: true
+        IMAGE_NAME: "geojupyter/workshop-open-source-geospatial"
+        # Put repo contents in /srv/repo, so they aren't mangled when we put user home in /home/jovyan
+        REPO_DIR: "/srv/repo"
+        # Fix man pages that are disabled by Ubuntu 18 minimal base image
+        # APPENDIX_FILE: "appendix"
+
+    # Lets us monitor disks getting full as images get bigger over time
+    - name: "Show how much disk space is left"
+      run: "df -h"

docker/README.md

@@ -0,0 +1,24 @@
+# GeoJupyter Docker image
+
+A Docker image containing geospatial tools and libraries needed for this workshop,
+intended to be run on [CryoCloud](https://cryointhecloud.com/)
+
+Use this image string in your JupyterHub:
+
+```
+ghcr.io/geojupyter/workshop-open-source-geospatial:latest
+```
+
+
+## How it's built
+
+This Docker image is built with
+[repo2docker](https://github.com/jupyterhub/repo2docker).
+
+repo2docker enables building and publishing a Docker image without Docker-specific
+knowledge.
+It uses familiar
+[configuration files](https://repo2docker.readthedocs.io/en/latest/config_files.html)
+like conda's `environment.yml` to generate the image, and the author of the repo2docker
+repository doesn't need to deal with frustrating complexities like environment
+activation or requirements to work as expected on a JupyterHub.

docker/apt.txt

@@ -0,0 +1,23 @@
+# Unix utilities
+man
+man-db
+manpages-posix
+manpages-dev
+manpages-posix-dev
+rsync
+tree
+tmux
+htop
+
+# Web utilities
+curl
+wget
+
+# Editors
+nano
+jed
+emacs-nox
+vim
+
+# Version control
+git

docker/custom_jupyter_server_config.json

@@ -0,0 +1,5 @@
+{
+    "ContentsManager": {
+        "allow_hidden": true
+    }
+}

docker/environment.yml

@@ -0,0 +1,49 @@
+channels:
+  - "conda-forge"
+  - "nodefaults"
+dependencies:
+  - "python==3.13"
+  - "jupyterlab>=4.4.2"
+
+  # Some cool extensions
+  - "jupyterlab-favorites"
+  - "jupyter-collaboration>=3,<4"
+  - "jupyter-server-proxy"
+  - "jupyterlab-myst"
+  - "jupyterlab-geojson"
+  - "nbdime"
+
+  # Python mainstays
+  - "numpy"
+  - "matplotlib"
+  - "hvplot"
+  - "pandas"
+  - "scipy"
+  - "xarray"
+
+  # geo
+  - "gdal"
+  - "geopandas"
+  - "rasterio"
+  - "rioxarray"
+  - "shapely"
+  - "pystac-client"
+  
+  # geo viz
+  - "jupytergis >=0.9.2"
+  - "leafmap"
+  - "folium"
+  - "cartopy"
+  - "geoviews"
+
+  # Publishing
+  - "mystmd"
+  - "typst"
+
+  # Testing and validation
+  - "ruff"
+  - "pre-commit"
+
+  # GitHub utilities
+  - "gh"
+  - "gh-scoped-creds"

docker/postBuild

@@ -0,0 +1,9 @@
+#!/bin/bash -l
+set -euo pipefail
+
+# Put our custom Jupyter Server config into appropriate platform
+# This path is determined by looking at output of `jupyter --path` in the hub
+# We copy both to notebook server config and jupyter server config, because either can be
+# used in the JupyterHub.
+cp custom_jupyter_server_config.json ${NB_PYTHON_PREFIX}/etc/jupyter/jupyter_server_config.d/
+cp custom_jupyter_server_config.json ${NB_PYTHON_PREFIX}/etc/jupyter/jupyter_notebook_config.d/

docker/start

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -euo pipefail
+
+# Set any environment variables here
+# These are inherited by all processes, *except* RStudio
+
+# Tell gh-scoped-creds which GitHub app to use for push access
+# See https://github.com/jupyterhub/gh-scoped-creds#github-app-configuration
+export GH_SCOPED_CREDS_CLIENT_ID="Iv1.bd27058fd393e285"
+export GH_SCOPED_CREDS_APP_URL="https://github.com/apps/cryocloud-github-access"
+
+exec "$@"