Merge pull request #5109 from rtfd/humitos/feature-flag-testing-image

Feature flag to use `readthedocs/build:testing` image

Author: humitos

readthedocs/doc_builder/environments.py

@@ -32,6 +32,7 @@
 from readthedocs.builds.models import BuildCommandResultMixin
 from readthedocs.core.utils import slugify
 from readthedocs.projects.constants import LOG_TEMPLATE
+from readthedocs.projects.models import Feature
 from readthedocs.restapi.client import api as api_v2
 
 from .constants import (
@@ -726,10 +727,18 @@ def __init__(self, *args, **kwargs):
                 project_name=self.project.slug,
             )[:DOCKER_HOSTNAME_MAX_LEN],
         )
+
+        # Decide what Docker image to use, based on priorities:
+        # Use the Docker image set by our feature flag: ``testing`` or,
+        if self.project.has_feature(Feature.USE_TESTING_BUILD_IMAGE):
+            self.container_image = 'readthedocs/build:testing'
+        # the image set by user or,
         if self.config and self.config.build.image:
             self.container_image = self.config.build.image
+        # the image overridden by the project (manually set by an admin).
         if self.project.container_image:
             self.container_image = self.project.container_image
+
         if self.project.container_mem_limit:
             self.container_mem_limit = self.project.container_mem_limit
         if self.project.container_time_limit:

readthedocs/projects/models.py

@@ -1010,6 +1010,7 @@ def add_features(sender, **kwargs):
     ALLOW_V2_CONFIG_FILE = 'allow_v2_config_file'
     MKDOCS_THEME_RTD = 'mkdocs_theme_rtd'
     DONT_SHALLOW_CLONE = 'dont_shallow_clone'
+    USE_TESTING_BUILD_IMAGE = 'use_testing_build_image'
 
     FEATURES = (
         (USE_SPHINX_LATEST, _('Use latest version of Sphinx')),
@@ -1024,6 +1025,8 @@ def add_features(sender, **kwargs):
         (MKDOCS_THEME_RTD, _('Use Read the Docs theme for MkDocs as default theme')),
         (DONT_SHALLOW_CLONE, _(
             'Do not shallow clone when cloning git repos')),
+        (USE_TESTING_BUILD_IMAGE, _(
+            'Use Docker image labelled as `testing` to build the docs')),
     )
 
     projects = models.ManyToManyField(