Build: shrink preview comment (#12391)

Implement what we discussed in
#12295. This is not
perfect and it doesn't pretend to be, it's just one of the
implementations after a few discussion iterations in the comments.

The idea of this PR is to have something a little better than what we
have to be able to merge and move forward with.

Closes #12295

Author: humitos

readthedocs/builds/tests/test_tasks.py

@@ -202,22 +202,20 @@ def test_post_build_overview(self, get_diff, post_comment):
         post_build_overview(build_pk=self.current_version_build.pk)
         expected_comment = dedent(
             f"""
-            ## Documentation build overview
+            ### Documentation build overview
 
-            > 📚 [My project](https://readthedocs.org/projects/my-project/) | 🛠️ build [#{self.current_version_build.id}](https://readthedocs.org/projects/my-project/builds/{self.current_version_build.id}/) (5678abcd) | 🔍 [preview](http://my-project--1.readthedocs.build/en/1/)
+            > 📚 [My project](https://readthedocs.org/projects/my-project/) | 🛠️ Build [#{self.current_version_build.id}](https://readthedocs.org/projects/my-project/builds/{self.current_version_build.id}/) | 📁 Comparing 5678abcd against [latest](http://my-project.readthedocs.io/en/latest/) (1234abcd)
 
-            ### Files changed
-
-            > Comparing with [latest](http://my-project.readthedocs.io/en/latest/) (1234abcd...5678abcd)
+            [<kbd><br />🔍 Preview build <br /></kbd>](http://my-project--1.readthedocs.build/en/1/)
 
 
             <details>
-            <summary>Show files (3) | 1 modified | 1 added | 1 deleted</summary>
+            <summary>Show files changed (3 files in total): 📝 1 modified | ➕ 1 added | ➖ 1 deleted</summary>
 
             | File | Status |
             | --- | --- |
             | [changes.html](http://my-project--1.readthedocs.build/en/1/changes.html) | ➕ added |
-            | [deleteme.html](http://my-project--1.readthedocs.build/en/1/deleteme.html) | ❌ deleted |
+            | [deleteme.html](http://my-project--1.readthedocs.build/en/1/deleteme.html) | ➖ deleted |
             | [index.html](http://my-project--1.readthedocs.build/en/1/index.html) | 📝 modified |
 
 
@@ -252,22 +250,20 @@ def test_post_build_overview_more_than_5_files(self, get_diff, post_comment):
         post_build_overview(build_pk=self.current_version_build.pk)
         expected_comment = dedent(
             f"""
-            ## Documentation build overview
-
-            > 📚 [My project](https://readthedocs.org/projects/my-project/) | 🛠️ build [#{self.current_version_build.id}](https://readthedocs.org/projects/my-project/builds/{self.current_version_build.id}/) (5678abcd) | 🔍 [preview](http://my-project--1.readthedocs.build/en/1/)
+            ### Documentation build overview
 
-            ### Files changed
+            > 📚 [My project](https://readthedocs.org/projects/my-project/) | 🛠️ Build [#{self.current_version_build.id}](https://readthedocs.org/projects/my-project/builds/{self.current_version_build.id}/) | 📁 Comparing 5678abcd against [latest](http://my-project.readthedocs.io/en/latest/) (1234abcd)
 
-            > Comparing with [latest](http://my-project.readthedocs.io/en/latest/) (1234abcd...5678abcd)
+            [<kbd><br />🔍 Preview build <br /></kbd>](http://my-project--1.readthedocs.build/en/1/)
 
 
             <details>
-            <summary>Show files (6) | 4 modified | 1 added | 1 deleted</summary>
+            <summary>Show files changed (6 files in total): 📝 4 modified | ➕ 1 added | ➖ 1 deleted</summary>
 
             | File | Status |
             | --- | --- |
             | [changes.html](http://my-project--1.readthedocs.build/en/1/changes.html) | ➕ added |
-            | [deleteme.html](http://my-project--1.readthedocs.build/en/1/deleteme.html) | ❌ deleted |
+            | [deleteme.html](http://my-project--1.readthedocs.build/en/1/deleteme.html) | ➖ deleted |
             | [index.html](http://my-project--1.readthedocs.build/en/1/index.html) | 📝 modified |
             | [one.html](http://my-project--1.readthedocs.build/en/1/one.html) | 📝 modified |
             | [three.html](http://my-project--1.readthedocs.build/en/1/three.html) | 📝 modified |
@@ -278,6 +274,7 @@ def test_post_build_overview_more_than_5_files(self, get_diff, post_comment):
 
             """
         )
+
         post_comment.assert_called_once_with(
             build=self.current_version_build,
             comment=expected_comment,
@@ -298,19 +295,18 @@ def test_post_build_overview_no_files_changed(self, get_diff, post_comment):
         post_build_overview(build_pk=self.current_version_build.pk)
         expected_comment = dedent(
             f"""
-            ## Documentation build overview
+            ### Documentation build overview
 
-            > 📚 [My project](https://readthedocs.org/projects/my-project/) | 🛠️ build [#{self.current_version_build.id}](https://readthedocs.org/projects/my-project/builds/{self.current_version_build.id}/) (5678abcd) | 🔍 [preview](http://my-project--1.readthedocs.build/en/1/)
+            > 📚 [My project](https://readthedocs.org/projects/my-project/) | 🛠️ Build [#{self.current_version_build.id}](https://readthedocs.org/projects/my-project/builds/{self.current_version_build.id}/) | 📁 Comparing 5678abcd against [latest](http://my-project.readthedocs.io/en/latest/) (1234abcd)
 
-            ### Files changed
-
-            > Comparing with [latest](http://my-project.readthedocs.io/en/latest/) (1234abcd...5678abcd)
+            [<kbd><br />🔍 Preview build <br /></kbd>](http://my-project--1.readthedocs.build/en/1/)
 
 
             No files changed.
 
             """
         )
+
         post_comment.assert_called_once_with(
             build=self.current_version_build,
             comment=expected_comment,

readthedocs/filetreediff/dataclasses.py

@@ -70,7 +70,7 @@ def emoji(self) -> str:
         if self == FileTreeDiffFileStatus.added:
             return "➕"
         elif self == FileTreeDiffFileStatus.deleted:
-            return "❌"
+            return "➖"
         elif self == FileTreeDiffFileStatus.modified:
             return "📝"
         return ""
@@ -155,7 +155,7 @@ def _sortpath(self, file: FileTreeDiffFile):
         However, it doesn't group the results by directory.
 
         Ideally, this should sort file names by hierarchy (less deep directory
-        first), groupping them by directory and alphabetically. We should update
+        first), grouping them by directory and alphabetically. We should update
         this function to achieve that goal if we find a simple way to do it.
         """
         parts = file.path.split("/")

readthedocs/templates/core/build-overview.md

@@ -4,17 +4,15 @@ Template used for generating the build overview page that is posted as a comment
 Whitespaces and newlines are important in some places like lists and tables,
 make sure to adjust the tags accordingly, as they introduce newlines.
 {% endcomment %}
-## Documentation build overview
+### Documentation build overview
 
-> 📚 [{{ project.name }}](https://{{ PRODUCTION_DOMAIN }}{% url "projects_detail" project.slug %}) | 🛠️ build [#{{ current_version_build.pk }}](https://{{ PRODUCTION_DOMAIN }}{% url "builds_detail" project.slug current_version_build.pk %}) ({{ current_version_build.commit }}) | 🔍 [preview]({{ current_version.get_absolute_url }})
+> 📚 [{{ project.name }}](https://{{ PRODUCTION_DOMAIN }}{% url "projects_detail" project.slug %}) | 🛠️ Build [#{{ current_version_build.pk }}](https://{{ PRODUCTION_DOMAIN }}{% url "builds_detail" project.slug current_version_build.pk %}) | 📁 Comparing {{ current_version_build.commit }} against [{{ base_version.verbose_name }}]({{ base_version.get_absolute_url }}) ({{ base_version_build.commit }})
 
-### Files changed
-
-> Comparing with [{{ base_version.verbose_name }}]({{ base_version.get_absolute_url }}) ({{ base_version_build.commit }}...{{ current_version_build.commit }})
+[<kbd><br />🔍 Preview build <br /></kbd>]({{ current_version.get_absolute_url }})
 
 {% if diff.files %}
 <details>
-<summary>Show files ({{ diff.files|length }}) | {{ diff.modified|length }} modified | {{ diff.added|length }} added | {{ diff.deleted|length }} deleted</summary>
+<summary>Show files changed ({{ diff.files|length }} files in total): 📝 {{ diff.modified|length }} modified | ➕ {{ diff.added|length }} added | ➖ {{ diff.deleted|length }} deleted</summary>
 
 | File | Status |
 | --- | --- |