Clarification on PR build webhooks and GitHub Action #11998
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding additional detail to aid in troubleshooting PR builds, and the PR build preview GitHub Action.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was setting up pull request builds and the Pull Request Build Preview GitHub Action 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.
📚 Documentation previews 📚
docs): https://docs--11998.org.readthedocs.build/en/11998/dev): https://dev--11998.org.readthedocs.build/en/11998/