build: update Documenter workflow (#249)

Author: oameye

.github/workflows/CleanPreviewDoc.yml

@@ -0,0 +1,31 @@
+name: Cleanup Preview Documentation
+
+on:
+  pull_request:
+    types: [closed]
+
+permissions:
+    contents: write
+    deployments: write
+
+jobs:
+  cleanup-preview-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              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:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            PRNUM: ${{ github.event.number }}

.github/workflows/Documenter.yml

@@ -0,0 +1,49 @@
+name: Documentation
+
+on:
+  push:
+    tags:
+      - '*'
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - 'master'
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+  statuses: write
+  pull-requests: read  # Required when using `push_preview=true`
+        
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: 'lts'
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+          JULIA_DEBUG: "Documenter"
+          DATADEPS_ALWAYS_ACCEPT: true
+          GKSwstype: "100" # for Plots.jl plots (if you have them)

.github/workflows/Tests.yml

@@ -3,7 +3,7 @@ name: Tests
 on:
   push:
     branches:
-      - 'main'
+      - 'master'
     paths:
       - '.github/workflows/Tests.yml'
       - 'src/**'
@@ -12,7 +12,7 @@ on:
       - 'Project.toml'
   pull_request:
     branches:
-      - 'main'
+      - 'master'
     paths:
       - '.github/workflows/Tests.yml'
       - 'src/**'

.github/workflows/docs.yml

@@ -49,4 +49,4 @@ makedocs(
     ),
 )
 
-deploydocs(repo = "github.com/qojulia/QuantumCumulants.jl.git", push_preview = false)
+deploydocs(repo = "github.com/qojulia/QuantumCumulants.jl.git", push_preview = true)