Skip to content

Commit 055a0e9

Browse files
committed
add rtd preview
1 parent e625549 commit 055a0e9

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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: "transformez"
22+
message-template: |
23+
---
24+
:mag: Docs preview: {docs-pr-index-url}

0 commit comments

Comments
 (0)