You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user/guides/pull-requests.rst
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,16 @@ See `Limitations`_ for more information.
22
22
The previous method of pull request previews using a GitHub workflow that called `@readthedocs/actions <https://github.com/readthedocs/actions/>`__ is now deprecated.
23
23
If you used that method, you should remove its configuration.
24
24
25
+
Build overview
26
+
--------------
27
+
28
+
You can enable a build overview comment to be added to your pull requests when changes are detected between the pull request and the latest version of the documentation.
29
+
This comment includes a list of the files that changed, and links to view the built documentation.
30
+
31
+
.. seealso::
32
+
:ref:`visual-diff:Show build overview in pull requests`
33
+
How to configure your project to enable build overviews
34
+
25
35
Privacy levels
26
36
--------------
27
37
@@ -65,7 +75,7 @@ Limitations
65
75
- Additional formats like PDF aren't built in order to reduce build time.
66
76
- Read the Docs doesn't index search on pull request builds. This means that Addons search and the Read the Docs Search API will return no results.
67
77
- The built documentation is kept for 90 days after the pull request has been closed or merged.
68
-
- In order to have pull request build links automatically added to your pull requests, you must configure an automation to accomplish this with your Git provider. For example, see `these instructions <https://github.com/readthedocs/actions/blob/v1/preview/README.md>`_ to configure with GitHub Actions.
78
+
- The build overview comment is only available for projects connected to a :ref:`reference/git-integration:GitHub App`.
69
79
70
80
Troubleshooting
71
81
---------------
@@ -89,11 +99,6 @@ No new builds are started when I open a pull request
89
99
You can (re)connect your account by going to your :guilabel:`<Username dropdown>`,
90
100
:guilabel:`Settings`, then to :guilabel:`Connected Services`.
91
101
92
-
Pull request build links (such as those generated from `the official GitHub Action <https://github.com/readthedocs/actions/blob/v1/preview/README.md>`_) return a 404 error
93
-
This means that a build is not being triggered.
94
-
95
-
Verify your repository's webhook is properly synced with Read the Docs, and configured to send pull request events. For GitHub, you can check this by visiting the "Webhooks" section of the repository's "Settings" page. For your Read the Docs webhook, under "Which events would you like to trigger this webhook?", choose "Send Me Everything," or manually select push events and all events relevant to pull requests.
96
-
97
102
Build status is not being reported to your Git provider
98
103
If opening a pull request does start a new build, but the build status is not
99
104
being updated with your Git provider, then your connected account may have out
0 commit comments