File tree Expand file tree Collapse file tree 1 file changed +27
-0
lines changed
Expand file tree Collapse file tree 1 file changed +27
-0
lines changed Original file line number Diff line number Diff line change 1+ # The ReadTheDocs preview link is "hidden" within the GitHub "Checks"
2+ # interface. For users who don't know this, finding the preview link may be
3+ # very difficult or frustrating. This workflow makes the link more
4+ # findable by updating PR descriptions to include it.
5+ name : ' Add ReadTheDocs preview link to PR description'
6+
7+ on :
8+ pull_request_target :
9+ types :
10+ - ' opened'
11+
12+ permissions :
13+ pull-requests : ' write'
14+
15+ jobs :
16+ autolink-rtd-previews :
17+ runs-on : ' ubuntu-latest'
18+ steps :
19+ - uses : ' readthedocs/actions/preview@v1'
20+ with :
21+ project-slug : ' jupyter-community-committee'
22+ single-version : true
23+ single-language : true
24+ message-template : |
25+ ---
26+ :mag: Preview: {docs-pr-index-url}
27+ _Note: This Pull Request preview is provided by ReadTheDocs. Our production website, however, is currently deployed with GitHub Pages._
You can’t perform that action at this time.
0 commit comments