Filtering pr - building preview only on specific labels

Author: lukdog

.github/workflows/preview.yml

@@ -1,24 +1,45 @@
 name: Preview Deployment
 
 on:
-  push:
-    branches:
-      - vercel-preview
   pull_request:
-    types: [opened, synchronize]
+    types: [opened, synchronize, labeled]
 
 concurrency:
-  group: vercel
+  group: netlify
   cancel-in-progress: false
 
 jobs:
   run:
+    if: contains(github.event.pull_request.labels.*.name, 'preview')
     runs-on: ubuntu-latest
+    concurrency:
+      group: netlify-${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
     env:
       REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
       APP_ENV: prod
 
     steps:
+
+      - name: Find PR Preview Comment
+        if: github.event_name == 'pull_request'
+        uses: peter-evans/find-comment@v1
+        id: deploy-preview-comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: "github-actions[bot]"
+          body-includes: "Preview this PR"
+          
+      - name: Update Comment if exists
+        if: github.event_name == 'pull_request' && steps.deploy-preview-comment.outputs.comment-id != 0
+        uses: peter-evans/[email protected]
+        with:
+          comment-id: ${{ steps.deploy-preview-comment.outputs.comment-id }}
+          edit-mode: replace
+          body: |
+            ## Preview Deployment
+            Waiting for deployment to complete...
+
       - uses: actions/checkout@v4
 
       - uses: actions/setup-node@v4
@@ -43,18 +64,18 @@ jobs:
         id: gatsby-cache-folder
         with:
           path: .cache
-          key: ${{ runner.os }}-cache-gatsbyV2-vercel-${{ github.sha }}
+          key: ${{ runner.os }}-cache-gatsbyV2-${{ github.sha }}
           restore-keys: |
-            ${{ runner.os }}-cache-gatsbyV2-vercel-
+            ${{ runner.os }}-cache-gatsbyV2-
 
       - name: Gatsby Public Folder
         uses: actions/cache@v4
         id: gatsby-public-folder
         with:
           path: public/
-          key: ${{ runner.os }}-public-gatsbyV2-vercel-${{ github.sha }}
+          key: ${{ runner.os }}-public-gatsbyV2-${{ github.sha }}
           restore-keys: |
-            ${{ runner.os }}-public-gatsbyV2-vercel-
+            ${{ runner.os }}-public-gatsbyV2-
 
       - run: npm install
       - run: npm run build
@@ -69,4 +90,32 @@ jobs:
             --dir public \
             --site ${{ secrets.NETLIFY_SITE_ID }} \
             --auth ${{ secrets.NETLIFY_AUTH_TOKEN }} \
-            --json
+            --json \
+            > deploy_output.json
+      
+      - name: Generate URL Preview
+        id: url_preview
+        run: |
+          NETLIFY_PREVIEW_URL=$(jq -r '.deploy_url' deploy_output.json)
+          echo "NETLIFY_PREVIEW_URL=$NETLIFY_PREVIEW_URL" >> "$GITHUB_OUTPUT"
+
+      - name: Create PR Preview Comment
+        if: github.event_name == 'pull_request' && steps.deploy-preview-comment.outputs.comment-id == 0
+        uses: peter-evans/[email protected]
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            ## Preview Deployment
+            🚀 Preview this PR: ${{ steps.url_preview.outputs.NETLIFY_PREVIEW_URL }}
+            📍 Commit SHA: ${{ github.sha }}
+      
+      - name: Update PR Preview Comment
+        if: github.event_name == 'pull_request' && steps.deploy-preview-comment.outputs.comment-id != 0
+        uses: peter-evans/[email protected]
+        with:
+          comment-id: ${{ steps.deploy-preview-comment.outputs.comment-id }}
+          edit-mode: replace
+          body: |
+            ## Preview Deployment
+            🚀 Preview this PR: ${{ steps.url_preview.outputs.NETLIFY_PREVIEW_URL }}
+            📍 Commit SHA: ${{ github.sha }}