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
Clarification on PR build webhooks and GitHub Action (#11998)
I was setting up pull request builds and the [Pull Request Build Preview
GitHub
Action](https://github.com/readthedocs/actions/blob/v1/preview/README.md)
and ran into some trouble. It ended up being that my repository's
webhook was set to only send push events, not all events, so I guess RTD
was not getting notified of pull requests and therefore not triggering
PR builds (despite having PR builds turned on in the RTD project
settings).
This is a quick shot at clarifying this behavior on the docs page. I
also added some clarification on the GitHub Action, because I feel it's
a fantastic feature, but it's a little hard to find if you don't already
know what you're looking for.
Let me know what you think - just wanted to get this going while it was
fresh on my mind.
<!-- readthedocs-preview docs start -->
---
:books: Documentation previews :books:
- User's documentation (`docs`):
https://docs--11998.org.readthedocs.build/en/11998/
<!-- readthedocs-preview docs end -->
<!-- readthedocs-preview dev start -->
- Developer's documentation (`dev`):
https://dev--11998.org.readthedocs.build/en/11998/
<!-- readthedocs-preview dev end -->
---------
Co-authored-by: Eric Holscher <[email protected]>
Copy file name to clipboardExpand all lines: docs/user/guides/pull-requests.rst
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ How to configure pull request builds
4
4
In this section, you can learn how to configure :doc:`pull request builds </pull-requests>`.
5
5
6
6
To enable pull request builds for your project,
7
-
your Read the Docs account needs to be connected to an account with a supported Git provider.
7
+
your Read the Docs account needs to be connected to an account with a supported Git provider, with a webhook configured to send information on pull requests for your repository.
8
8
See `Limitations`_ for more information.
9
9
10
10
If your account is already connected:
@@ -55,12 +55,13 @@ Limitations
55
55
56
56
- Pull requests are only available for **GitHub** and **GitLab** currently. Bitbucket is not yet supported.
57
57
- To enable this feature, your Read the Docs account needs to be connected to an
58
-
account with your Git provider.
58
+
account with your Git provider, *and* the connecting webhook must be configured to send on creation of a pull request, not just on pushes to your main branch.
59
59
- Builds from pull requests have the same memory and time limitations
60
60
:doc:`as regular builds </builds>`.
61
61
- Additional formats like PDF aren't built in order to reduce build time.
62
62
- 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.
63
63
- The built documentation is kept for 90 days after the pull request has been closed or merged.
64
+
- 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.
64
65
65
66
Troubleshooting
66
67
---------------
@@ -80,6 +81,11 @@ No new builds are started when I open a pull request
80
81
You can (re)connect your account by going to your :guilabel:`<Username dropdown>`,
81
82
:guilabel:`Settings`, then to :guilabel:`Connected Services`.
82
83
84
+
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
85
+
This means that a build is not being triggered.
86
+
87
+
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.
88
+
83
89
Build status is not being reported to your Git provider
84
90
If opening a pull request does start a new build, but the build status is not
85
91
being updated with your Git provider, then your connected account may have out
0 commit comments