forked from nsidc/earthaccess
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add workflow to update PRs with docs preview link in description
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
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
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: "earthaccess" |