Skip to content

Commit 38f1a36

Browse files
mfisher87RRosio
andcommitted
Add automation to add link to RTD preview build to every PR
Co-authored-by: Rosio <[email protected]>
1 parent 325a2be commit 38f1a36

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.github/workflows/pr-rtd-link.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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._

0 commit comments

Comments
 (0)