Enable Documenter preview for PRs (#63)

* push preview * add some more badges * remove duplicate docs * Change badge order --------- Co-authored-by: Michael Ingold <[email protected]>
JuliaGeometry · Sep 5, 2024 · b1c4bfb · b1c4bfb
1 parent 450cc1d
commit b1c4bfb
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 21 deletions.
diff --git a/.github/workflows/DocPreviewCleanup.yml b/.github/workflows/DocPreviewCleanup.yml
@@ -0,0 +1,33 @@
+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 "[email protected]"
+              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 }}
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # MeshIntegrals.jl
 
+[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://mikeingold.github.io/MeshIntegrals.jl/stable/)
+[![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://mikeingold.github.io/MeshIntegrals.jl/dev/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)
 [![ColPrac](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet?style=flat-square)](https://github.com/SciML/ColPrac)
 

diff --git a/docs/make.jl b/docs/make.jl
@@ -7,7 +7,6 @@ makedocs(
         "Home" => [
             "About" => "index.md",
             "Support Matrix" => "supportmatrix.md",
-            "Integration Algorithms" => "algorithms.md",
             "Example Usage" => "usage.md"
         ],
         "Derivations" => [
@@ -17,4 +16,6 @@ makedocs(
     ]
 )
 
-deploydocs(repo = "github.com/mikeingold/MeshIntegrals.jl.git")
+deploydocs(repo = "github.com/mikeingold/MeshIntegrals.jl.git",
+           devbranch = "main",
+           push_preview = true)
diff --git a/docs/src/algorithms.md b/docs/src/algorithms.md
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,4 +1,14 @@
 # MeshIntegrals.jl
 
+[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://mikeingold.github.io/MeshIntegrals.jl/stable/)
+[![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://mikeingold.github.io/MeshIntegrals.jl/dev/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)
+[![ColPrac](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet?style=flat-square)](https://github.com/SciML/ColPrac)
+
+[![Build Status](https://github.com/mikeingold/MeshIntegrals.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/mikeingold/MeshIntegrals.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/mikeingold/MeshIntegrals.jl/graph/badge.svg)](https://codecov.io/gh/mikeingold/MeshIntegrals.jl)
+[![Coveralls](https://coveralls.io/repos/github/mikeingold/MeshIntegrals.jl/badge.svg?branch=main)](https://coveralls.io/github/mikeingold/MeshIntegrals.jl?branch=main)
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
+
 **MeshIntegrals.jl** is a Julia library that leverages differential forms to implement fast
 and easy numerical integration of field equations over geometric domains.