Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workflow to update PRs with docs preview link in description #414

Merged
merged 3 commits into from
Dec 20, 2023
Merged

Add workflow to update PRs with docs preview link in description #414

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
867c0f5
Add workflow to update PRs with docs preview link in description
mfisher87 Dec 18, 2023
d386e13
Only execute action on PR open
mfisher87 Dec 19, 2023
7e0038f
Format with prettier
mfisher87 Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/pr-rtd-link.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 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:
jhkennedy marked this conversation as resolved.
Show resolved Hide resolved
types:
- opened

permissions:
pull-requests: "write"
mfisher87 marked this conversation as resolved.
Show resolved Hide resolved

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