From 173cd395eb121da062972eaeff7ba670bb23a568 Mon Sep 17 00:00:00 2001
From: Matt Fisher <mfisher87@gmail.com>
Date: Mon, 18 Dec 2023 08:10:43 -0700
Subject: [PATCH] Add GHA workflow to auto-add RTD preview link to PR
 descriptions

---
 .github/workflows/pr-rtd-link.yml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 .github/workflows/pr-rtd-link.yml

diff --git a/.github/workflows/pr-rtd-link.yml b/.github/workflows/pr-rtd-link.yml
new file mode 100644
index 00000000..5b3b52a8
--- /dev/null
+++ b/.github/workflows/pr-rtd-link.yml
@@ -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"