Migrate @kadena/docs to use Vercel CLI to deploy to preview environments.

.github/scripts/prune-deployment.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+# Set the pipefail option.
+set -o pipefail
+
+# Get the Vercel API endpoints.
+GET_DEPLOYMENTS_ENDPOINT="https://api.vercel.com/v6/deployments"
+DELETE_DEPLOYMENTS_ENDPOINT="https://api.vercel.com/v13/deployments"
+
+# Create a list of deployments.
+deployments=$(curl -s -X GET "$GET_DEPLOYMENTS_ENDPOINT/?teamId=$VERCEL_ORG_ID" -H "Authorization: Bearer $VERCEL_TOKEN ")
+
+# Filter the deployments list by meta.pr_data === meta tag.
+filtered_deployments=$(echo $deployments | jq --arg META_TAG "$META_TAG" '[.deployments[] | select(.meta.pr_data | type == "string" and contains($META_TAG)) | .uid] | join(",")')
+filtered_deployments="${filtered_deployments//\"/}" # Remove double quotes
+
+# Clears the values from filtered_deployments
+IFS=',' read -ra values <<<"$filtered_deployments"
+
+echo "META_TAG ${META_TAG}"
+echo "Filtered deployments ${filtered_deployments}"
+
+# Iterate over the filtered deployments list.
+for uid in "${values[@]}"; do
+    echo "Deleting ${uid}"
+
+    delete_url=${DELETE_DEPLOYMENTS_ENDPOINT}/${uid}?teamId=${VERCEL_ORG_ID}
+    echo $delete_url
+
+    # Make DELETE a request to the /v13/deployments/{id} endpoint.
+    curl -X DELETE $delete_url -H "Authorization: Bearer $VERCEL_TOKEN"
+
+    echo "Deleted!"
+done

.github/workflows/delete-preview.yml

@@ -0,0 +1,31 @@
+
+name: Remove deploy preview
+
+permissions:
+  contents: read
+  statuses: write
+  pull-requests: write
+
+env:
+  VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  delete-deployments:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+          show-progress: false
+
+      - name: Prune preview deployments associated with merged PR
+        env:
+          META_TAG: ${{ github.event.repository.name }}-${{ github.event.number }}
+        run: |
+          bash .github/scripts/prune-deployment.sh

.github/workflows/deploy-preview.yml

@@ -0,0 +1,100 @@
+name: Deploy to Vercel Preview
+on:
+  workflow_call:
+    # Introduced 'inputs' to define parameters that can be passed when calling this workflow
+    inputs:
+      app:
+        description: "App to Deploy"
+        required: true
+        type: string
+    secrets:
+      VERCEL_PROJECT_ID:
+        description: "Vercel Project ID"
+        required: true
+      VERCEL_ORG_ID:
+        description: "Vercel Organization ID"
+        required: true
+      VERCEL_TOKEN:
+        description: "Vercel Token"
+        required: true
+
+env: 
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+
+
+jobs:
+  shouldDeploy:
+    name: ${{ inputs.app }}
+    if: ${{ github.repository_owner == 'kadena-community' }} // Prevents auto deploying forks.
+
+    runs-on: ubuntu-latest
+    steps:
+     - uses: actions/checkout@v4
+       with:
+          fetch-depth: 0
+          show-progress: false
+
+     - name: Runner Setup  
+       uses: ./.github/actions/runner-setup
+
+     - name: Detecting App Changes
+       id: detectChanges
+       run: | 
+        echo "Detecting Changes"
+
+        # Enable Error Handling
+        set +e
+
+        npx turbo-ignore @kadena/${{ inputs.app }} -f origin/main
+        exit_code=$?
+
+        # Disable Error Handling
+        set -e
+
+        echo "exit_code: $exit_code"
+        if [ $exit_code -eq 0 ]; then
+          echo "changed=false" >> $GITHUB_OUTPUT
+        else
+          echo "changed=true" >> $GITHUB_OUTPUT
+        fi
+    outputs:
+      changed: ${{ steps.detectChanges.outputs.changed }} 
+  deploy:
+    name: ${{ inputs.app }}
+    needs: shouldDeploy
+    if: ${{ needs.shouldDeploy.outputs.changed == 'true' }}
+    environment:
+      name: ${{ inputs.app }} - Preview
+      url: ${{ steps.deployment.outputs.url }}
+
+    runs-on: ubuntu-latest
+    steps:
+     - uses: actions/checkout@v4
+       with:
+          fetch-depth: 0
+          show-progress: false
+
+     - name: Runner Setup  
+       uses: ./.github/actions/runner-setup
+
+     - name: Install Vercel CLI
+       if: steps.detectChanges.outputs.changed == 'true' 
+       run: pnpm add --global vercel@34.2.5 
+
+     - name: Pull environment variables
+       if: steps.detectChanges.outputs.changed == 'true' 
+       run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+
+     - name: Build App
+       if: steps.detectChanges.outputs.changed == 'true' 
+       run: vercel build --token=${{ secrets.VERCEL_TOKEN }} --debug
+
+     - name: Deploy App
+       if: steps.detectChanges.outputs.changed == 'true' 
+       run: vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }} --archive=tgz --meta pr_data=${{ github.event.repository.name }}-${{ github.event.number }} | tee deploy.log
+
+     - name: Set preview url
+       if: steps.detectChanges.outputs.changed == 'true' 
+       id: deployment
+       run: echo "url=$(tail -1 deploy.log)">> $GITHUB_OUTPUT

.github/workflows/vercel.yml

@@ -0,0 +1,23 @@
+name: Creating Preview environments
+on: 
+    pull_request:
+jobs:
+  create-preview-env:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+            - app: 'Docs'
+              projectToken: VERCEL_DOCS_ID
+            - app: 'Tools'
+              projectToken: VERCEL_TOOLS_ID
+            - app: 'dev-wallet'
+              projectToken: VERCEL_DEV_WALLET_ID
+    name: Preview Deployment
+    uses: ./.github/workflows/deploy-preview.yml
+    with:
+      app: ${{ matrix.app}}
+    secrets:
+        VERCEL_PROJECT_ID: ${{ secrets[matrix.projectToken] }}
+        VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+        VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}

.gitignore

@@ -101,4 +101,5 @@ temp
 .cache-sh
 
 # parcel
-.parcel-cache
+.parcel-cache
+.vercel

.pnpmfile.cjs

@@ -9,6 +9,8 @@ const ALLOWED_ROOT_DEPENDENCIES = [
   'syncpack',
   'tsx',
   'turbo',
+  'vercel',
+  'turbo-ignore',
 ];
 
 function readPackage(pkg, context) {

package.json

@@ -36,7 +36,9 @@
     "prettier-plugin-packagejson": "^2.4.6",
     "syncpack": "^11.2.1",
     "tsx": "^3.12.10",
-    "turbo": "^1.10.15"
+    "turbo": "^1.10.15",
+    "turbo-ignore": "^2.0.3",
+    "vercel": "34.2.5"
   },
   "engines": {
     "node": ">=18 <21",