From b9fcd8d350ce960361e3245960e674cb4588b550 Mon Sep 17 00:00:00 2001
From: cgarling <chris.t.garling@gmail.com>
Date: Sun, 26 May 2024 09:32:11 -0400
Subject: [PATCH] add docs cleanup action for PR previews

---
 .github/workflows/CleanupDocs.yml | 34 +++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 .github/workflows/CleanupDocs.yml

diff --git a/.github/workflows/CleanupDocs.yml b/.github/workflows/CleanupDocs.yml
new file mode 100644
index 0000000..7eaf5ab
--- /dev/null
+++ b/.github/workflows/CleanupDocs.yml
@@ -0,0 +1,34 @@
+# This workflow was based on CliMA/ClimaTimeSteppers.jl (Apache License 2.0).
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+# Ensure that only one "Doc Preview Cleanup" workflow is force pushing at a time
+concurrency:
+  group: doc-preview-cleanup
+  cancel-in-progress: false
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+          if [ -d "${preview_dir}" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "documenter@juliadocs.github.io"
+              git rm -rf "${preview_dir}"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+          fi
+        env:
+          preview_dir: previews/PR${{ github.event.number }}
\ No newline at end of file