Merge tag '11.7.1' into rel

Author: humitos

CHANGELOG.rst

@@ -1,3 +1,15 @@
+Version 11.7.1
+--------------
+
+:Date: September 03, 2024
+
+* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#11575 <https://github.com/readthedocs/readthedocs.org/pull/11575>`__)
+* `@stsewd <https://github.com/stsewd>`__: SAML: update Okta setup steps (`#11569 <https://github.com/readthedocs/readthedocs.org/pull/11569>`__)
+* `@humitos <https://github.com/humitos>`__: Notifications: small typo (`#11568 <https://github.com/readthedocs/readthedocs.org/pull/11568>`__)
+* `@humitos <https://github.com/humitos>`__: Release 11.7.0 (`#11567 <https://github.com/readthedocs/readthedocs.org/pull/11567>`__)
+* `@humitos <https://github.com/humitos>`__: Add project: skip config step if YAML file is present (`#11540 <https://github.com/readthedocs/readthedocs.org/pull/11540>`__)
+* `@stsewd <https://github.com/stsewd>`__: Allauth: don't completely override the `send_email` method (`#11526 <https://github.com/readthedocs/readthedocs.org/pull/11526>`__)
+
 Version 11.7.0
 --------------
 

docs/conf.py

@@ -76,7 +76,7 @@
 
 master_doc = "index"
 copyright = "Read the Docs, Inc & contributors"
-version = "11.7.0"
+version = "11.7.1"
 release = version
 exclude_patterns = ["_build", "shared", "_includes"]
 default_role = "obj"

docs/user/guides/set-up-single-sign-on-saml.rst

@@ -35,6 +35,7 @@ In order to enable SSO with Okta, you need to create a new SAML application in y
    * :guilabel:`Single Sign On URL`: ``https://readthedocs.com/accounts/saml/<organization-slug>/acs/`` (replace ``<organization-slug>`` with your organization slug)
    * :guilabel:`Audience URI (SP Entity ID)`: ``https://readthedocs.com/accounts/saml/<organization-slug>/metadata/`` (replace ``<organization-slug>`` with your organization slug)
    * :guilabel:`Name ID format`: ``EmailAddress``
+   * :guilabel:`Application username`: ``Email``
    * Leave the rest of the fields as default.
 
 6. Add the following "attribute statements" to be used when creating a new user:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "readthedocs",
-  "version": "11.7.0",
+  "version": "11.7.1",
   "description": "Read the Docs build dependencies",
   "author": "Read the Docs, Inc <[email protected]>",
   "scripts": {

readthedocs/__init__.py

@@ -1,4 +1,4 @@
 """Read the Docs."""
 
 
-__version__ = "11.7.0"
+__version__ = "11.7.1"

readthedocs/api/v3/tests/responses/notifications-list.json

@@ -31,7 +31,7 @@
       "id": 2,
       "message": {
         "body": "Your project is currently disabled for abuse of the system.\nPlease make sure it isn't using unreasonable amounts of resources or triggering lots of builds in a short amount of time.\nPlease <a href=\"mailto:None\">contact support</a> to get your project re-enabled.",
-        "header": "Build skipped for this project",
+        "header": "Builds skipped for this project",
         "icon_classes": "fas fa-circle-info",
         "id": "project:invalid:skip-builds",
         "type": "info"

readthedocs/api/v3/tests/responses/projects-notifications-detail.json

@@ -8,7 +8,7 @@
   "id": 2,
   "message": {
     "body": "Your project is currently disabled for abuse of the system.\nPlease make sure it isn't using unreasonable amounts of resources or triggering lots of builds in a short amount of time.\nPlease <a href=\"mailto:None\">contact support</a> to get your project re-enabled.",
-    "header": "Build skipped for this project",
+    "header": "Builds skipped for this project",
     "icon_classes": "fas fa-circle-info",
     "id": "project:invalid:skip-builds",
     "type": "info"

readthedocs/api/v3/tests/responses/projects-notifications-list.json

@@ -13,7 +13,7 @@
       "id": 2,
       "message": {
         "body": "Your project is currently disabled for abuse of the system.\nPlease make sure it isn't using unreasonable amounts of resources or triggering lots of builds in a short amount of time.\nPlease <a href=\"mailto:None\">contact support</a> to get your project re-enabled.",
-        "header": "Build skipped for this project",
+        "header": "Builds skipped for this project",
         "icon_classes": "fas fa-circle-info",
         "id": "project:invalid:skip-builds",
         "type": "info"

readthedocs/core/adapters.py

@@ -1,13 +1,10 @@
 """Allauth overrides."""
 
-import json
-
 import structlog
 from allauth.account.adapter import DefaultAccountAdapter
-from django.template.loader import render_to_string
 from django.utils.encoding import force_str
 
-from readthedocs.core.utils import send_email
+from readthedocs.core.utils import send_email_from_object
 from readthedocs.invitations.models import Invitation
 
 log = structlog.get_logger(__name__)
@@ -20,36 +17,25 @@ class AccountAdapter(DefaultAccountAdapter):
     def format_email_subject(self, subject):
         return force_str(subject)
 
-    def send_mail(self, template_prefix, email, context):
-        subject = render_to_string(
-            "{}_subject.txt".format(template_prefix),
-            context,
-        )
-        subject = " ".join(subject.splitlines()).strip()
-        subject = self.format_email_subject(subject)
+    def render_mail(self, template_prefix, email, context, headers=None):
+        """
+        Wrapper around render_mail to send emails using a task.
+
+        ``send_email`` makes use of the email object returned by this method,
+        and calls ``send`` on it. We override this method to return a dummy
+        object that has a ``send`` method, which in turn calls our task to send
+        the email.
+        """
+        email = super().render_mail(template_prefix, email, context, headers=headers)
+
+        class DummyEmail:
+            def __init__(self, email):
+                self.email = email
 
-        # Allauth sends some additional data in the context, remove it if the
-        # pieces can't be json encoded
-        removed_keys = []
-        for key in list(context.keys()):
-            try:
-                _ = json.dumps(context[key])  # noqa for F841
-            except (ValueError, TypeError):
-                removed_keys.append(key)
-                del context[key]
-        if removed_keys:
-            log.debug(
-                "Removed context we were unable to serialize.",
-                removed_keys=removed_keys,
-            )
+            def send(self):
+                send_email_from_object(self.email)
 
-        send_email(
-            recipient=email,
-            subject=subject,
-            template="{}_message.txt".format(template_prefix),
-            template_html="{}_message.html".format(template_prefix),
-            context=context,
-        )
+        return DummyEmail(email)
 
     def save_user(self, request, user, form, commit=True):
         """Override default account signup to redeem invitations at sign-up."""

readthedocs/core/utils/__init__.py

@@ -5,6 +5,7 @@
 
 import structlog
 from django.conf import settings
+from django.core.mail import EmailMessage, EmailMultiAlternatives
 from django.template.loader import render_to_string
 from django.utils.functional import keep_lazy
 from django.utils.safestring import SafeText, mark_safe
@@ -274,6 +275,25 @@ def cancel_build(build):
     app.control.revoke(build.task_id, signal=signal.SIGINT, terminate=terminate)
 
 
+def send_email_from_object(email: EmailMultiAlternatives | EmailMessage):
+    """Given an email object, send it using our send_email_task task."""
+    from readthedocs.core.tasks import send_email_task
+
+    html_content = None
+    if isinstance(email, EmailMultiAlternatives):
+        for content, mimetype in email.alternatives:
+            if mimetype == "text/html":
+                html_content = content
+                break
+    send_email_task.delay(
+        recipient=email.to,
+        subject=email.subject,
+        content=email.body,
+        content_html=html_content,
+        from_email=email.from_email,
+    )
+
+
 def send_email(
     recipient,
     subject,

readthedocs/projects/notifications.py

@@ -17,7 +17,7 @@
 messages = [
     Message(
         id=MESSAGE_PROJECT_SKIP_BUILDS,
-        header=_("Build skipped for this project"),
+        header=_("Builds skipped for this project"),
         body=_(
             textwrap.dedent(
                 """

readthedocs/projects/views/private.py

@@ -49,7 +49,8 @@
 from readthedocs.integrations.models import HttpExchange, Integration
 from readthedocs.invitations.models import Invitation
 from readthedocs.notifications.models import Notification
-from readthedocs.oauth.services import registry
+from readthedocs.oauth.constants import GITHUB
+from readthedocs.oauth.services import GitHubService, registry
 from readthedocs.oauth.tasks import attach_webhook
 from readthedocs.oauth.utils import update_webhook
 from readthedocs.projects.filters import ProjectListFilterSet
@@ -347,7 +348,57 @@ def get_form_kwargs(self, step=None):
 
     def get_template_names(self):
         """Return template names based on step name."""
-        return "projects/import_{}.html".format(self.steps.current)
+        return f"projects/import_{self.steps.current}.html"
+
+    def process_step(self, form):
+        # pylint: disable=too-many-nested-blocks
+        if isinstance(form, ProjectBasicsForm):
+            remote_repository = form.cleaned_data.get("remote_repository")
+            if remote_repository and remote_repository.vcs_provider == GITHUB:
+                remote_repository_relations = (
+                    remote_repository.remote_repository_relations.filter(
+                        user=self.request.user,
+                        account__isnull=False,
+                    )
+                    .select_related("account", "user")
+                    .only("user", "account")
+                )
+                for relation in remote_repository_relations:
+                    service = GitHubService(relation.user, relation.account)
+                    session = service.get_session()
+
+                    for yaml in [
+                        ".readthedocs.yaml",
+                        ".readthedocs.yml",
+                        "readthedocs.yaml",
+                        "readthedocs.yml",
+                    ]:
+                        try:
+                            response = session.head(
+                                f"https://api.github.com/repos/{remote_repository.full_name}/contents/{yaml}",
+                                timeout=1,
+                            )
+                            if response.ok:
+                                log.info(
+                                    "Read the Docs YAML file found for this repository.",
+                                    filename=yaml,
+                                )
+                                messages.success(
+                                    self.request,
+                                    _(
+                                        "We detected a configuration file in your repository and started your project's first build."
+                                    ),
+                                )
+                                self.form_list.pop("config")
+                                break
+                        except Exception:
+                            log.warning(
+                                "Failed when hitting GitHub API to check for .readthedocs.yaml file.",
+                                filename=yaml,
+                            )
+                            continue
+
+        return super().process_step(form)
 
     def done(self, form_list, **kwargs):
         """

requirements/deploy.txt

@@ -23,11 +23,11 @@ billiard==3.6.4.0
     # via
     #   -r requirements/pip.txt
     #   celery
-boto3==1.35.5
+boto3==1.35.10
     # via
     #   -r requirements/pip.txt
     #   django-storages
-botocore==1.35.5
+botocore==1.35.10
     # via
     #   -r requirements/pip.txt
     #   boto3
@@ -38,7 +38,7 @@ celery==5.2.7
     # via
     #   -r requirements/pip.txt
     #   django-celery-beat
-certifi==2024.7.4
+certifi==2024.8.30
     # via
     #   -r requirements/pip.txt
     #   elastic-transport
@@ -121,7 +121,7 @@ django==4.2.15
     #   django-timezone-field
     #   djangorestframework
     #   jsonfield
-django-allauth[mfa,saml,socialaccount]==64.1.0
+django-allauth[mfa,saml,socialaccount]==64.2.0
     # via -r requirements/pip.txt
 django-annoying==0.10.7
     # via -r requirements/pip.txt
@@ -147,7 +147,7 @@ django-filter==24.3
     # via -r requirements/pip.txt
 django-formtools==2.3
     # via -r requirements/pip.txt
-django-gravatar2==1.4.4
+django-gravatar2==1.4.5
     # via -r requirements/pip.txt
 django-ipware==5.0.2
     # via
@@ -224,7 +224,7 @@ idna==3.8
     # via
     #   -r requirements/pip.txt
     #   requests
-ipython==8.26.0
+ipython==8.27.0
     # via -r requirements/deploy.in
 isodate==0.6.1
     # via
@@ -321,7 +321,7 @@ pypng==0.20220715.0
     # via
     #   -r requirements/pip.txt
     #   qrcode
-pyquery==2.0.0
+pyquery==2.0.1
     # via -r requirements/pip.txt
 python-crontab==3.2.0
     # via

requirements/docker.txt

@@ -25,11 +25,11 @@ billiard==3.6.4.0
     # via
     #   -r requirements/pip.txt
     #   celery
-boto3==1.35.5
+boto3==1.35.10
     # via
     #   -r requirements/pip.txt
     #   django-storages
-botocore==1.35.5
+botocore==1.35.10
     # via
     #   -r requirements/pip.txt
     #   boto3
@@ -42,7 +42,7 @@ celery==5.2.7
     # via
     #   -r requirements/pip.txt
     #   django-celery-beat
-certifi==2024.7.4
+certifi==2024.8.30
     # via
     #   -r requirements/pip.txt
     #   elastic-transport
@@ -131,7 +131,7 @@ django==4.2.15
     #   django-timezone-field
     #   djangorestframework
     #   jsonfield
-django-allauth[mfa,saml,socialaccount]==64.1.0
+django-allauth[mfa,saml,socialaccount]==64.2.0
     # via -r requirements/pip.txt
 django-annoying==0.10.7
     # via -r requirements/pip.txt
@@ -157,7 +157,7 @@ django-filter==24.3
     # via -r requirements/pip.txt
 django-formtools==2.3
     # via -r requirements/pip.txt
-django-gravatar2==1.4.4
+django-gravatar2==1.4.5
     # via -r requirements/pip.txt
 django-ipware==5.0.2
     # via
@@ -239,7 +239,7 @@ idna==3.8
     #   requests
 ipdb==0.13.13
     # via -r requirements/docker.in
-ipython==8.26.0
+ipython==8.27.0
     # via ipdb
 isodate==0.6.1
     # via
@@ -349,7 +349,7 @@ pypng==0.20220715.0
     #   qrcode
 pyproject-api==1.7.1
     # via tox
-pyquery==2.0.0
+pyquery==2.0.1
     # via -r requirements/pip.txt
 pyrepl==0.9.0
     # via fancycompleter
@@ -400,7 +400,7 @@ requests-toolbelt==1.0.0
     # via -r requirements/pip.txt
 rest-framework-generic-relations==2.2.0
     # via -r requirements/pip.txt
-rich==13.7.1
+rich==13.8.0
     # via -r requirements/docker.in
 s3transfer==0.10.2
     # via