Build: add support for Ubuntu 24.04 LTS (#11421)

* Build: add support for Ubuntu 24.04 LTS Closes #11072 Requires: * readthedocs/readthedocs-docker-images#207 * readthedocs/readthedocs-ops#1494 * Update scripts/compile_version_upload_s3.sh Co-authored-by: Eric Holscher <[email protected]> * Don't update Ubuntu latest yet --------- Co-authored-by: Eric Holscher <[email protected]>
readthedocs · Jun 18, 2024 · bc50f97 · bc50f97
1 parent 44b2732
commit bc50f97
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/docs/user/config-file/v2.rst b/docs/user/config-file/v2.rst
@@ -274,7 +274,7 @@ Image names refer to the operating system Read the Docs uses to build them.
    Arbitrary Docker images are not supported.
 
 :Type: ``string``
-:Options: ``ubuntu-20.04``, ``ubuntu-22.04``, ``ubuntu-lts-latest``
+:Options: ``ubuntu-20.04``, ``ubuntu-22.04``, ``ubuntu-24.04``, ``ubuntu-lts-latest``
 :Required: ``true``
 
 .. note::

diff --git a/readthedocs/builds/constants_docker.py b/readthedocs/builds/constants_docker.py
@@ -25,6 +25,7 @@
     "os": {
         "ubuntu-20.04": f"{DOCKER_DEFAULT_IMAGE}:ubuntu-20.04",
         "ubuntu-22.04": f"{DOCKER_DEFAULT_IMAGE}:ubuntu-22.04",
+        "ubuntu-24.04": f"{DOCKER_DEFAULT_IMAGE}:ubuntu-24.04",
     },
     # Mapping of build.tools options to specific versions.
     "tools": {
@@ -75,7 +76,11 @@
 # Set latest aliases for OS and tools.
 _OS = RTD_DOCKER_BUILD_SETTINGS["os"]
 _TOOLS = RTD_DOCKER_BUILD_SETTINGS["tools"]
+
+# TODO: point ``ubuntu-lts-latest`` to Ubuntu 24.04 LTS once we have tested it
+# in production after some weeks
 _OS["ubuntu-lts-latest"] = _OS["ubuntu-22.04"]
+
 _TOOLS["python"]["3"] = _TOOLS["python"]["3.12"]
 _TOOLS["python"]["latest"] = _TOOLS["python"]["3"]
 _TOOLS["python"]["miniconda-latest"] = _TOOLS["python"]["miniconda3-3.12-24.1"]

diff --git a/readthedocs/rtd_tests/fixtures/spec/v2/schema.json b/readthedocs/rtd_tests/fixtures/spec/v2/schema.json
@@ -61,6 +61,7 @@
           "enum": [
             "ubuntu-20.04",
             "ubuntu-22.04",
+            "ubuntu-24.04",
             "ubuntu-lts-latest"
           ]
         },

diff --git a/scripts/compile_version_upload_s3.sh b/scripts/compile_version_upload_s3.sh
@@ -60,15 +60,15 @@ set -x # Echo commands
 
 # Define variables
 SLEEP=900 # Container timeout
-OS="${OS:-ubuntu-22.04}" # Docker image name
+OS="${OS:-ubuntu-24.04}" # Docker image name
 
 TOOL=$1
 VERSION=$2
 
 # https://stackoverflow.com/questions/59895/how-can-i-get-the-source-directory-of-a-bash-script-from-within-the-script-itsel
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 
-# Spin up a container with the Ubuntu 20.04 LTS image
+# Spin up a container with the latest Ubuntu LTS image
 CONTAINER_ID=$(docker run --user docs --rm --detach --volume ${SCRIPT_DIR}/python-build.diff:/tmp/python-build.diff readthedocs/build:$OS sleep $SLEEP)
 echo "Running all the commands in Docker container: $CONTAINER_ID"