gh-pages: Switch to action deploy (#551)

For the repo size reduction #543 switch to using actions based
deployment of our github pages.

The pr-preview functionality will return in a later PR.

Author: cypres

.github/workflows/docs-deploy.yaml

@@ -37,7 +37,7 @@ concurrency:
 
 jobs:
   # Build job for Sphinx documentation
-  deploy:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -84,14 +84,18 @@ jobs:
         uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
         with:
           path: 'docs/public/'
-
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
       - name: Deploy to GitHub Pages
-        uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
-        with:
-          branch: gh-pages/documentation
-          folder: docs/public
-          clean-exclude: |
-            pr-preview/
-            .nojekyll
-          force: false
-          single-commit: true
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

.github/workflows/pr-checks.yaml

@@ -293,12 +293,6 @@ jobs:
             exit 1
           fi
 
-      - name: Deploy preview
-        uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1.8.1
-        with:
-          source-dir: ./docs/public/
-          preview-branch: gh-pages/documentation
-
       - name: Run spelling check
         id: spelling
         if: github.event.action != 'closed'