Previews

Author: chrisguidry

.github/workflows/docs.yml

@@ -5,21 +5,26 @@ on:
     branches:
       - main
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
     branches:
       - main
 
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+  contents: write # needed for pr-preview-action to commit to gh-pages
   pull-requests: write
+  pages: write # for the official pages deployment
+  id-token: write # for the official pages deployment
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
 jobs:
-  build:
+  build-and-deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -39,37 +44,24 @@ jobs:
       - name: Build site
         run: uv run mkdocs build
 
+      # For main branch pushes, use official GitHub Pages deployment
       - name: Upload Pages artifact
+        if: github.ref == 'refs/heads/main'
         uses: actions/upload-pages-artifact@v3
         with:
           path: site
-          name: github-pages
-
-  publish:
-    needs: build
-    runs-on: ubuntu-latest
-    environment:
-      name: ${{ github.event_name == 'pull_request' && format('preview-pr-{0}', github.event.pull_request.number) || 'github-pages' }}
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
 
       - name: Deploy to GitHub Pages
-        id: deployment
+        if: github.ref == 'refs/heads/main'
         uses: actions/deploy-pages@v4
         with:
-          preview: ${{ github.event_name == 'pull_request' }}
+          artifact_name: github-pages
 
-      - name: Comment PR
+      # For PRs, deploy preview using pr-preview-action
+      - name: Deploy PR Preview
         if: github.event_name == 'pull_request'
-        uses: actions/github-script@v7
+        uses: rossjrw/pr-preview-action@v1
         with:
-          script: |
-            const comment = `📚 Documentation preview for this PR is ready!\n\nYou can view it at: ${{ steps.deployment.outputs.page_url }}`;
-            github.rest.issues.createComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.issue.number,
-              body: comment
-            });
+          source-dir: site
+          preview-branch: main
+          umbrella-dir: pr-preview