PR Build tab added to project dashboard

Author: saadmk11

readthedocs/builds/models.py

@@ -745,6 +745,11 @@ def is_stale(self):
     def using_latest_config(self):
         return int(self.config.get('version', '1')) == LATEST_CONFIGURATION_VERSION
 
+    @property
+    def is_pr(self):
+        """Return if build is a Pull Request Build."""
+        return self.version.type == PULL_REQUEST
+
 
 class BuildCommandResultMixin:
 

readthedocs/builds/views.py

@@ -117,6 +117,42 @@ def get_context_data(self, **kwargs):
         return context
 
 
+class PRBuildList(BuildBase, BuildTriggerMixin, ListView):
+    template_name = 'builds/pr_build_list.html'
+
+    def get_queryset(self):
+        # this is used to include only internal version
+        # builds in the build list page
+        self.project_slug = self.kwargs.get('project_slug', None)
+        self.project = get_object_or_404(
+            Project.objects.protected(self.request.user),
+            slug=self.project_slug,
+        )
+        queryset = Build.external.public(
+            user=self.request.user,
+            project=self.project,
+        ).select_related('project', 'version')
+
+        return queryset
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+
+        active_builds = self.get_queryset().exclude(
+            state='finished',
+        ).values('id')
+
+        context['project'] = self.project
+        context['active_builds'] = active_builds
+        context['versions'] = Version.external.public(
+            user=self.request.user,
+            project=self.project,
+        )
+        context['build_qs'] = self.get_queryset()
+
+        return context
+
+
 class BuildDetail(BuildBase, DetailView):
     pk_url_kwarg = 'build_pk'
 

readthedocs/projects/models.py

@@ -519,6 +519,14 @@ def get_builds_url(self):
             },
         )
 
+    def get_pr_builds_url(self):
+        return reverse(
+            'pr_builds_project_list',
+            kwargs={
+                'project_slug': self.slug,
+            },
+        )
+
     def get_canonical_url(self):
         if settings.DONT_HIT_DB:
             return api.project(self.pk).canonical_url().get()['url']

readthedocs/projects/urls/public.py

@@ -71,6 +71,11 @@
         build_views.BuildList.as_view(),
         name='builds_project_list',
     ),
+    url(
+        (r'^(?P<project_slug>{project_slug})/builds/pr/$'.format(**pattern_opts)),
+        build_views.PRBuildList.as_view(),
+        name='pr_builds_project_list',
+    ),
     url(
         r'^(?P<project_slug>{project_slug})/versions/$'.format(**pattern_opts),
         public.project_versions,

readthedocs/templates/builds/build_detail.html

@@ -22,9 +22,19 @@
 {% endblock %}
 
 {% block project_editing %}
-  {% with builds_active="active" %}
-    {% include "core/project_bar.html" %}
-  {% endwith %}
+
+  {% if build.is_pr %}
+
+    {% with pr_builds_active="active" %}
+      {% include "core/project_bar.html" %}
+    {% endwith %}
+  {% else %}
+    {% with builds_active="active" %}
+      {% include "core/project_bar.html" %}
+    {% endwith %}
+
+  {% endif %}
+
 {% endblock %}
 
 {% block content %}

readthedocs/templates/builds/pr_build_list.html

@@ -0,0 +1,46 @@
+{% extends "projects/base_project.html" %}
+
+{% load i18n %}
+{% load static %}
+
+{% load pagination_tags %}
+{% load privacy_tags %}
+{% load projects_tags %}
+
+{% block title %}Builds{% endblock %}
+
+{% block project_editing %}
+    {% with pr_builds_active="active" %}
+        {% include "core/project_bar.html" %}
+    {% endwith %}
+{% endblock %}
+
+{% block content %}
+
+
+<div id="build_list">
+
+        {% autopaginate build_qs 15 %}
+
+        <!-- BEGIN builds list -->
+        <div class="module">
+          <div class="module-wrapper">
+            <h1>{% trans "Recent Pull Request Builds" %}</h1>
+
+            <div class="module-list">
+              <div class="module-list-wrapper">
+                <ul>
+                  {% include "core/build_list_detailed.html" %}
+                </ul>
+              </div>
+            </div>
+
+          </div>
+        </div>
+        <!-- END builds list -->
+
+        {% paginate %}
+
+</div>
+
+{% endblock %}

readthedocs/templates/core/project_bar_base.html

@@ -45,6 +45,8 @@ <h1>
 
         <li class="{{ builds_active }}"><a href="{{ project.get_builds_url }}">{% trans "Builds" %}</a></li>
 
+        <li class="{{ pr_builds_active }}"><a href="{{ project.get_pr_builds_url }}">{% trans "PR Builds" %}</a></li>
+
         <li class="{{ versions_active }}"><a href="{% url "project_version_list" project.slug %}">{% trans "Versions" %}</a></li>
 
         {% comment %}