Skip to content

Commit 8b320d6

Browse files
committed
External naming updated
1 parent 24c70b6 commit 8b320d6

File tree

11 files changed

+34
-44
lines changed

11 files changed

+34
-44
lines changed

readthedocs/builds/models.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -746,9 +746,9 @@ def using_latest_config(self):
746746
return int(self.config.get('version', '1')) == LATEST_CONFIGURATION_VERSION
747747

748748
@property
749-
def is_pr(self):
750-
"""Return if build is a Pull Request Build."""
751-
return self.version.type == PULL_REQUEST
749+
def is_external(self):
750+
"""Return if build is a External ie: Pull/Merge Request Build."""
751+
return self.version.type == EXTERNAL
752752

753753

754754
class BuildCommandResultMixin:

readthedocs/builds/views.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ def get_context_data(self, **kwargs):
117117
return context
118118

119119

120-
class PRBuildList(BuildBase, ListView):
121-
template_name = 'builds/pr_build_list.html'
120+
class ExternalBuildList(BuildBase, ListView):
121+
template_name = 'builds/external_build_list.html'
122122

123123
def get_queryset(self):
124124
# this is used to include only internal version

readthedocs/projects/models.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -519,9 +519,9 @@ def get_builds_url(self):
519519
},
520520
)
521521

522-
def get_pr_builds_url(self):
522+
def get_external_builds_url(self):
523523
return reverse(
524-
'pr_builds_project_list',
524+
'external_builds_project_list',
525525
kwargs={
526526
'project_slug': self.slug,
527527
},

readthedocs/projects/urls/public.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@
7373
),
7474
url(
7575
(r'^(?P<project_slug>{project_slug})/builds/pr/$'.format(**pattern_opts)),
76-
build_views.PRBuildList.as_view(),
77-
name='pr_builds_project_list',
76+
build_views.ExternalBuildList.as_view(),
77+
name='external_builds_project_list',
7878
),
7979
url(
8080
r'^(?P<project_slug>{project_slug})/versions/$'.format(**pattern_opts),

readthedocs/rtd_tests/tests/test_builds.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from django_dynamic_fixture import fixture, get
88
from django.utils import timezone
99

10-
from readthedocs.builds.constants import PULL_REQUEST
10+
from readthedocs.builds.constants import EXTERNAL
1111
from readthedocs.builds.models import Build, Version
1212
from readthedocs.doc_builder.config import load_yaml_config
1313
from readthedocs.doc_builder.environments import LocalBuildEnvironment
@@ -584,26 +584,26 @@ def test_using_latest_config(self):
584584

585585
self.assertTrue(build.using_latest_config())
586586

587-
def test_build_is_pr(self):
588-
# Turn the build version to pull request type.
589-
self.version.type = PULL_REQUEST
587+
def test_build_is_external(self):
588+
# Turn the build version to EXTERNAL type.
589+
self.version.type = EXTERNAL
590590
self.version.save()
591591

592-
pr_build = get(
592+
external_build = get(
593593
Build,
594594
project=self.project,
595595
version=self.version,
596596
config={'version': 1},
597597
)
598598

599-
self.assertTrue(pr_build.is_pr)
599+
self.assertTrue(external_build.is_external)
600600

601-
def test_build_is_not_pr(self):
601+
def test_build_is_not_external(self):
602602
build = get(
603603
Build,
604604
project=self.project,
605605
version=self.version,
606606
config={'version': 1},
607607
)
608608

609-
self.assertFalse(build.is_pr)
609+
self.assertFalse(build.is_external)

readthedocs/rtd_tests/tests/test_doc_serving.py

-10
Original file line numberDiff line numberDiff line change
@@ -240,16 +240,6 @@ def test_sitemap_xml(self):
240240
project=self.public,
241241
active=True
242242
)
243-
# This is a EXTERNAL Version
244-
external_version = fixture.get(
245-
Version,
246-
identifier='pr-version',
247-
verbose_name='pr-version',
248-
slug='pr-9999',
249-
project=self.public,
250-
active=True,
251-
type=EXTERNAL
252-
)
253243
stable_version = fixture.get(
254244
Version,
255245
identifier='stable',

readthedocs/rtd_tests/tests/test_project.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ def test_has_good_build_excludes_external_versions(self):
166166
# Test that PR Version is not considered for has_good_build.
167167
self.assertFalse(self.pip.has_good_build)
168168

169-
def test_get_pr_builds_url(self):
169+
def test_get_external_builds_url(self):
170170
self.assertEqual(
171-
self.pip.get_pr_builds_url(),
171+
self.pip.get_external_builds_url(),
172172
f'/projects/{self.pip.slug}/builds/pr/'
173173
)
174174

readthedocs/rtd_tests/tests/test_views.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from django.urls import reverse
88
from django_dynamic_fixture import get, new
99

10-
from readthedocs.builds.constants import LATEST, EXTERNAL
10+
from readthedocs.builds.constants import LATEST, EXTERNAL, BRANCH
1111
from readthedocs.builds.models import Build, Version
1212
from readthedocs.core.permissions import AdminPermission
1313
from readthedocs.projects.forms import UpdateProjectForm
@@ -297,26 +297,26 @@ def test_build_list_does_not_include_external_versions(self):
297297
self.assertNotIn(external_version_build, response.context['build_qs'])
298298
self.assertNotIn(external_version_build, response.context['active_builds'])
299299

300-
def test_pr_build_list_includes_pr_version_builds(self):
301-
pr_version = get(
300+
def test_external_build_list_includes_external_version_builds(self):
301+
external_version = get(
302302
Version,
303303
project = self.pip,
304304
active = True,
305-
type = PULL_REQUEST,
305+
type = EXTERNAL,
306306
)
307-
pr_version_build = get(
307+
external_version_build = get(
308308
Build,
309309
project = self.pip,
310-
version = pr_version
310+
version = external_version
311311
)
312312
response = self.client.get(
313-
reverse('pr_builds_project_list', args=[self.pip.slug]),
313+
reverse('external_builds_project_list', args=[self.pip.slug]),
314314
)
315315

316316
self.assertEqual(response.status_code, 200)
317-
self.assertIn(pr_version_build, response.context['build_qs'])
317+
self.assertIn(external_version_build, response.context['build_qs'])
318318

319-
def test_pr_build_list_does_not_include_internal_version_builds(self):
319+
def test_external_build_list_does_not_include_internal_version_builds(self):
320320
internal_version = get(
321321
Version,
322322
project = self.pip,
@@ -329,7 +329,7 @@ def test_pr_build_list_does_not_include_internal_version_builds(self):
329329
version = internal_version
330330
)
331331
response = self.client.get(
332-
reverse('pr_builds_project_list', args=[self.pip.slug]),
332+
reverse('external_builds_project_list', args=[self.pip.slug]),
333333
)
334334

335335
self.assertEqual(response.status_code, 200)

readthedocs/templates/builds/build_detail.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323

2424
{% block project_editing %}
2525

26-
{% if build.is_pr %}
26+
{% if build.is_external %}
2727

28-
{% with pr_builds_active="active" %}
28+
{% with external_builds_active="active" %}
2929
{% include "core/project_bar.html" %}
3030
{% endwith %}
3131
{% else %}

readthedocs/templates/builds/pr_build_list.html renamed to readthedocs/templates/builds/external_build_list.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
{% block title %}Builds{% endblock %}
1111

1212
{% block project_editing %}
13-
{% with pr_builds_active="active" %}
13+
{% with external_builds_active="active" %}
1414
{% include "core/project_bar.html" %}
1515
{% endwith %}
1616
{% endblock %}
@@ -25,7 +25,7 @@
2525
<!-- BEGIN builds list -->
2626
<div class="module">
2727
<div class="module-wrapper">
28-
<h1>{% trans "Recent Pull Request Builds" %}</h1>
28+
<h1>{% trans "Recent External Builds" %}</h1>
2929

3030
<div class="module-list">
3131
<div class="module-list-wrapper">

readthedocs/templates/core/project_bar_base.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ <h1>
4545

4646
<li class="{{ builds_active }}"><a href="{{ project.get_builds_url }}">{% trans "Builds" %}</a></li>
4747

48-
<li class="{{ pr_builds_active }}"><a href="{{ project.get_pr_builds_url }}">{% trans "PR Builds" %}</a></li>
48+
<li class="{{ external_builds_active }}"><a href="{{ project.get_external_builds_url }}">{% trans "External Builds" %}</a></li>
4949

5050
<li class="{{ versions_active }}"><a href="{% url "project_version_list" project.slug %}">{% trans "Versions" %}</a></li>
5151

0 commit comments

Comments
 (0)