Build contributed recipes in PRs (#2212)

* Build contributed recipes in PRs

* Fix GitHub matrix

.github/workflows/contributed-recipes.yml

@@ -43,8 +43,17 @@ jobs:
       - name: Checkout Repo ⚡️
         uses: actions/checkout@v4
 
+      - name: Load image to Docker 📥
+        if: ${{ github.event_name == 'workflow_call' && matrix.parent-image != '' }}
+        uses: ./.github/actions/load-image
+        with:
+          image: ${{ matrix.parent-image }}
+          platform: ${{ matrix.platform }}
+          variant: default
+
+      # Not pulling the image, because it might be loaded from previous step or will be downloaded automatically
       - name: Build recipe 🛠
-        run: docker build --pull --rm --force-rm --tag my-custom-image -f ./${{ matrix.dockerfile }} ./
+        run: docker build --rm --force-rm --tag my-custom-image -f ./${{ matrix.dockerfile }} ./
         env:
           DOCKER_BUILDKIT: 1
           # Full logs for CI build

docs/using/recipe_code/custom_environment.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/minimal-notebook
+ARG BASE_IMAGE=quay.io/jupyter/minimal-notebook
+FROM $BASE_IMAGE
 
 # Name your environment and choose the Python version
 ARG env_name=python310

docs/using/recipe_code/dask_jupyterlab.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 # Install the Dask dashboard
 RUN mamba install --yes 'dask-labextension' && \

docs/using/recipe_code/generate_matrix.py

@@ -2,24 +2,39 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import json
-import os
 from pathlib import Path
 from typing import Any
 
 THIS_DIR = Path(__file__).parent.resolve()
-REPOSITORY_OWNER = os.environ["REPOSITORY_OWNER"]
 
 
-def generate_matrix() -> dict[str, Any]:
+def generate_matrix() -> Any:
-    dockerfiles = sorted(file.name for file in THIS_DIR.glob("*.dockerfile"))
+    dockerfiles = sorted(THIS_DIR.glob("*.dockerfile"))
     runs_on = ["ubuntu-24.04", "ubuntu-22.04-arm"]
-    return {
+
-        "dockerfile": dockerfiles,
+    configurations = []
-        "runs-on": runs_on,
+    for dockerfile in dockerfiles:
-        "exclude": [
+        dockerfile_name = dockerfile.name
-            {"dockerfile": "oracledb.dockerfile", "runs-on": "ubuntu-22.04-arm"}
+        for run in runs_on:
-        ],
+            if dockerfile_name == "oracledb.dockerfile" and run == "ubuntu-22.04-arm":
-    }
+                continue
+            dockerfile_lines = dockerfile.read_text().splitlines()
+            base_image = [
+                line for line in dockerfile_lines if line.startswith("ARG BASE_IMAGE=")
+            ][0][15:]
+            base_image_short = base_image[base_image.rfind("/") + 1 :]
+            # Handling a case of `docker.io/jupyter/base-notebook:notebook-6.5.4` image
+            if ":" in base_image_short:
+                base_image_short = ""
+            configurations.append(
+                {
+                    "dockerfile": dockerfile_name,
+                    "runs-on": run,
+                    "platform": "x86_64" if run == "ubuntu-24.04" else "aarch64",
+                    "parent-image": base_image_short,
+                }
+            )
+    return {"include": configurations}
 
 
 if __name__ == "__main__":

docs/using/recipe_code/ijavascript.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 USER root
 

docs/using/recipe_code/jupyterhub_version.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 RUN mamba install --yes 'jupyterhub-singleuser==4.0.1' && \
     mamba clean --all -f -y && \

docs/using/recipe_code/mamba_install.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 RUN mamba install --yes 'flake8' && \
     mamba clean --all -f -y && \

docs/using/recipe_code/manpage_install.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 # Fix: https://github.com/hadolint/hadolint/wiki/DL4006
 # Fix: https://github.com/koalaman/shellcheck/wiki/SC3014

docs/using/recipe_code/microsoft_odbc.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 # Fix: https://github.com/hadolint/hadolint/wiki/DL4006
 # Fix: https://github.com/koalaman/shellcheck/wiki/SC3014

docs/using/recipe_code/oracledb.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 USER root
 

docs/using/recipe_code/pip_install.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 # Install in the default python3 environment
 RUN pip install --no-cache-dir 'flake8' && \

docs/using/recipe_code/rise_jupyterlab.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 RUN mamba install --yes 'jupyterlab_rise' && \
     mamba clean --all -f -y && \

docs/using/recipe_code/spellcheck_notebook_v6.dockerfile

@@ -1,5 +1,6 @@
 # Using Docker Hub here, because this image is old and not pushed to Quay.io
-FROM docker.io/jupyter/base-notebook:notebook-6.5.4
+ARG BASE_IMAGE=docker.io/jupyter/base-notebook:notebook-6.5.4
+FROM $BASE_IMAGE
 
 RUN pip install --no-cache-dir 'jupyter_contrib_nbextensions' && \
     jupyter contrib nbextension install --user && \

docs/using/recipe_code/xgboost.dockerfile

@@ -1,4 +1,5 @@
-FROM quay.io/jupyter/base-notebook
+ARG BASE_IMAGE=quay.io/jupyter/base-notebook
+FROM $BASE_IMAGE
 
 RUN mamba install --yes 'py-xgboost' && \
     mamba clean --all -f -y && \