Merge tag '7.1.0' into rel

humitos · humitos · commit cf662a2dd256 · 2022-01-25T08:30:13.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -5,9 +5,9 @@ about: Report some incorrect or unexpected behavior
 
 ## Details
 
-* Read the Docs project URL:
-* Build URL (if applicable):
-* Read the Docs username (if applicable):
+* Read the Docs project URL: https://readthedocs.org/projects/{your_project_slug}/
+* Build URL (if applicable): https://readthedocs.org/projects/{your_project_slug}/builds/{build_id}/
+* Read the Docs username (if applicable): https://readthedocs.org/profiles/{your_rtd_username}/
 
 ## Expected Result
 
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,20 @@
+Version 7.1.0
+-------------
+
+:Date: January 25, 2022
+
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Detail what URLs are expected in issue template (`#8832 <https://github.com/readthedocs/readthedocs.org/pull/8832>`__)
+* `@humitos <https://github.com/humitos>`__: Cleanup: delete unused Django management commands (`#8830 <https://github.com/readthedocs/readthedocs.org/pull/8830>`__)
+* `@simonw <https://github.com/simonw>`__: Canonical can point as stable, not just latest (`#8828 <https://github.com/readthedocs/readthedocs.org/pull/8828>`__)
+* `@humitos <https://github.com/humitos>`__: Docs: remove `USE_TESTING_BUILD_IMAGE` (`#8824 <https://github.com/readthedocs/readthedocs.org/pull/8824>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Use stickybox ad placement on RTD themed projects (`#8823 <https://github.com/readthedocs/readthedocs.org/pull/8823>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Quiet the Unresolver logging (`#8822 <https://github.com/readthedocs/readthedocs.org/pull/8822>`__)
+* `@stsewd <https://github.com/stsewd>`__: Workaround for HttpExchange queries casting IDs as uuid/int wrongly (`#8821 <https://github.com/readthedocs/readthedocs.org/pull/8821>`__)
+* `@stsewd <https://github.com/stsewd>`__: Fix queryset for generic models (`#8820 <https://github.com/readthedocs/readthedocs.org/pull/8820>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Release 7.0.0 (`#8818 <https://github.com/readthedocs/readthedocs.org/pull/8818>`__)
+* `@pyup-bot <https://github.com/pyup-bot>`__: pyup:  Scheduled weekly dependency update for week 03 (`#8817 <https://github.com/readthedocs/readthedocs.org/pull/8817>`__)
+* `@stsewd <https://github.com/stsewd>`__: Subscriptions: move views  (`#8816 <https://github.com/readthedocs/readthedocs.org/pull/8816>`__)
+
 Version 7.0.0
 -------------
 
diff --git a/docs/user/custom_domains.rst b/docs/user/custom_domains.rst
@@ -147,7 +147,7 @@ so that they can send people to the correct page.
 
 Read the Docs uses these in two ways:
 
-* We point all versions of your docs at the "latest" version as canonical
+* We point all versions of your docs at default version, usually "latest" or "stable", as canonical.
 * We point at the user specified canonical URL, generally a custom domain for your docs.
 
 Example
diff --git a/docs/user/feature-flags.rst b/docs/user/feature-flags.rst
@@ -32,8 +32,6 @@ The ``DONT_SHALLOW_CLONE`` flag is useful if your code accesses old commits duri
 e.g. python-reno release notes manager is known to do that
 (error message line would probably include one of old Git commit id's).
 
-``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`
-
 ``LIST_PACKAGES_INSTALLED_ENV``: :featureflags:`LIST_PACKAGES_INSTALLED_ENV`
 
 ``DONT_CREATE_INDEX``: :featureflags:`DONT_CREATE_INDEX`
diff --git a/readthedocs/builds/models.py b/readthedocs/builds/models.py
@@ -412,21 +412,6 @@ def get_storage_environment_cache_path(self):
         """Return the path of the cached environment tar file."""
         return build_environment_storage.join(self.project.slug, f'{self.slug}.tar')
 
-    def clean_build_path(self):
-        """
-        Clean build path for project version.
-
-        Ensure build path is clean for project version. Used to ensure stale
-        build checkouts for each project version are removed.
-        """
-        try:
-            path = self.get_build_path()
-            if path is not None:
-                log.debug('Removing build path for project.', path=path, project_slug=self.slug)
-                rmtree(path)
-        except OSError:
-            log.exception('Build path cleanup failed')
-
     def get_github_url(
             self,
             docroot,
diff --git a/readthedocs/core/management/commands/clean_builds.py b/readthedocs/core/management/commands/clean_builds.py
diff --git a/readthedocs/core/management/commands/pull.py b/readthedocs/core/management/commands/pull.py
diff --git a/readthedocs/core/management/commands/update_versions.py b/readthedocs/core/management/commands/update_versions.py
diff --git a/readthedocs/core/static-src/core/js/doc-embed/sponsorship.js b/readthedocs/core/static-src/core/js/doc-embed/sponsorship.js
@@ -29,6 +29,8 @@ function inject_ads_client() {
 function create_ad_placement() {
     var selector = null;
     var class_name;         // Used for theme specific CSS customizations
+    var style_name;
+    var ad_type = "readthedocs-sidebar";
     var element;
     var offset;
 
@@ -51,7 +53,13 @@ function create_ad_placement() {
         class_name = 'ethical-rtd ethical-dark-theme';
     } else if (rtd.is_rtd_like_theme()) {
         selector = 'nav.wy-nav-side > div.wy-side-scroll';
-        class_name = 'ethical-rtd ethical-dark-theme';
+        if (Math.random() <= 0.1) {
+          // Use the stickybox placement 10% of the time during rollout
+          style_name = 'stickybox';
+          ad_type = 'image';
+        } else {
+          class_name = 'ethical-rtd ethical-dark-theme';
+        }
     } else if (rtd.is_alabaster_like_theme()) {
         selector = 'div.sphinxsidebar > div.sphinxsidebarwrapper';
         class_name = 'ethical-alabaster';
@@ -78,8 +86,9 @@ function create_ad_placement() {
         return $('<div />')
             .attr("id", "rtd-sidebar")
             .attr("data-ea-publisher", "readthedocs")
-            .attr("data-ea-type", "readthedocs-sidebar")
+            .attr("data-ea-type", ad_type)
             .attr("data-ea-manual", "true")
+            .attr("data-ea-style", style_name)
             .addClass(class_name)
             .appendTo(selector);
     }
diff --git a/readthedocs/core/static/core/js/readthedocs-doc-embed.js b/readthedocs/core/static/core/js/readthedocs-doc-embed.js
diff --git a/readthedocs/core/unresolver.py b/readthedocs/core/unresolver.py
@@ -79,7 +79,7 @@ def unresolve_from_request(self, request, path):
             # We need to add the index.html to find this actual file
             filename += 'index.html'
 
-        log.info(
+        log.debug(
             'Unresolver parsed.',
             project_slug=final_project.slug,
             lang_slug=lang_slug,
diff --git a/readthedocs/projects/views/private.py b/readthedocs/projects/views/private.py
@@ -634,6 +634,7 @@ class WebHookExchangeDetail(WebHookMixin, DetailView):
     def get_queryset(self):
         # NOTE: We are explicitly using the id instead of the the object
         # to avoid a bug where the id is wrongly casted as an uuid.
+        # https://code.djangoproject.com/ticket/33450
         return self.model.objects.filter(webhook__id=self.get_webhook().id)
 
     def get_webhook(self):
@@ -918,9 +919,7 @@ class IntegrationExchangeDetail(IntegrationMixin, DetailView):
     template_name = 'projects/integration_exchange_detail.html'
 
     def get_queryset(self):
-        # NOTE: We are explicitly using the id instead of the the object
-        # to avoid a bug where the id is wrongly casted as an uuid.
-        return self.model.objects.filter(integrations__id=self.get_integration().id)
+        return self.model.objects.filter(integrations=self.get_integration())
 
     def get_object(self):
         return DetailView.get_object(self)
diff --git a/requirements/deploy.txt b/requirements/deploy.txt
@@ -2,7 +2,7 @@
 
 -r pip.txt
 
-psycopg2==2.9.2
+psycopg2==2.9.3
 gunicorn==20.1.0
 django-redis-cache==3.0.0
 
diff --git a/requirements/docker.txt b/requirements/docker.txt
@@ -26,7 +26,7 @@ argh==0.26.2
 tox==3.24.5
 
 # AWS utilities to use against MinIO
-awscli==1.22.31
+awscli==1.22.37
 
 # Used together with structlog to have nicer logs locally
 rich==11.0.0
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1,6 +1,6 @@
 # Packages required to build docs, independent of application dependencies
 
-Sphinx==4.3.2
+Sphinx==4.4.0
 Pygments==2.11.2
 
 sphinx_rtd_theme==1.0.0
diff --git a/requirements/pip.txt b/requirements/pip.txt
@@ -12,7 +12,7 @@ django-simple-history==3.0.0
 djangorestframework==3.13.1
 
 # For intersphinx during builds
-Sphinx==4.3.2
+Sphinx==4.4.0
 
 # Filtering for the REST API
 django-filter==21.1
@@ -55,9 +55,9 @@ requests-oauthlib==1.3.0
 GitPython==3.1.18  # pyup: ignore
 
 # Search
-elasticsearch==7.16.2  # pyup: <8.0.0
+elasticsearch==7.16.3  # pyup: <8.0.0
 elasticsearch-dsl==7.4.0  # pyup: <8.0
-django-elasticsearch-dsl==7.2.1  # pyup: <8.0
+django-elasticsearch-dsl==7.2.2  # pyup: <8.0
 selectolax==0.3.6
 
 # embed
diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = readthedocs
-version = 7.0.0
+version = 7.1.0
 license = MIT
 description = Read the Docs builds and hosts documentation
 author = Read the Docs, Inc
