Skip to content

Commit

Permalink
Add GHA workflow to auto-add RTD preview link to PR descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Dec 18, 2023
1 parent 2e0d36a commit 173cd39
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/pr-rtd-link.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# The ReadTheDocs preview link is "hidden" within the GitHub "Checks"
# interface. For users who don't know this, finding the preview link may be
# very difficult or frustrating. This workflow makes the link more
# findable by updating PR descriptions to include it.
name: "Add ReadTheDocs preview link to PR descriptions"

on:
pull_request_target:

permissions:
pull-requests: "write"

jobs:
autolink-rtd-previews:
runs-on: "ubuntu-latest"
steps:
- uses: "readthedocs/actions/preview@v1"
with:
project-slug: "qgreenland"

0 comments on commit 173cd39

Please sign in to comment.