From 6e4f9030f50f94db6874737637d23076f0ae7af1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stefan=20Str=C3=B6mer?= <stefan.stroemer@ait.ac.at>
Date: Mon, 3 Jun 2024 18:47:55 +0200
Subject: [PATCH] docs: add CI workflow to cleanup leftover files from push
 previews

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

diff --git a/.github/workflows/DocPreviewCleanup.yml b/.github/workflows/DocPreviewCleanup.yml
new file mode 100644
index 0000000..2d3c291
--- /dev/null
+++ b/.github/workflows/DocPreviewCleanup.yml
@@ -0,0 +1,35 @@
+# See: https://documenter.juliadocs.org/stable/man/hosting/#Cleaning-up-gh-pages
+# for more information on why and how to use this workflow.
+
+name: DocPreviewCleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+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 }}