chore: implement ai suggestions

evansims · evansims · commit 6c20cdb437dc · 2025-08-18T19:41:15.000-05:00
diff --git a/.github/actions/setup-and-build/action.yml b/.github/actions/setup-and-build/action.yml
@@ -2,7 +2,7 @@ name: "Setup and Build"
 description: "Setup Node.js, install dependencies, and optionally build"
 inputs:
   node-version:
-    description: "Node.js version"
+    description: "Node.js version (can use env.DEFAULT_NODE_VERSION or repository variable)"
     required: false
     default: "22"
   build:
@@ -22,28 +22,27 @@ inputs:
     required: false
     default: ""
   npm-ci-flags:
-    description: "Additional flags for npm ci (e.g. --ignore-scripts --no-audit --no-fund)"
+    description: "Flags for npm ci (default: --no-audit --no-fund --prefer-offline). Add --ignore-scripts if needed to skip postinstall scripts"
     required: false
-    default: ""
+    default: "--no-audit --no-fund --prefer-offline"
 
 runs:
   using: "composite"
   steps:
     - name: Setup Node.js
-      if: inputs.setup == 'true'
+      if: ${{ inputs.setup == 'true' }}
       uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
       with:
         node-version: ${{ inputs.node-version }}
-        registry-url: "https://registry.npmjs.org"
         cache: "npm"
 
     - name: Install dependencies
-      if: inputs.setup == 'true'
+      if: ${{ inputs.setup == 'true' }}
       shell: bash
       run: npm ci ${{ inputs.npm-ci-flags }}
 
     - name: Build website
-      if: inputs.build == 'true'
+      if: ${{ inputs.build == 'true' }}
       shell: bash
       env:
         HUBSPOT_TRACKING_ID: ${{ inputs.build-analytics-id }}
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -23,7 +23,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
-          lfs: true
+          lfs: true  # LFS required for building with images/assets
           fetch-depth: 1
 
       - name: Setup and build
@@ -34,6 +34,30 @@ jobs:
       - name: Create CNAME file
         run: echo "openfga.dev" > ./build/CNAME
 
+      - name: Preserve PR previews from gh-pages
+        timeout-minutes: 5
+        run: |
+          # Clone the gh-pages branch with authentication to avoid rate limits and support private repos
+          if git clone --branch gh-pages --single-branch --depth 1 \
+            https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git gh-pages-temp 2>/dev/null; then
+            
+            # Copy pr-preview directory if it exists
+            if [ -d "gh-pages-temp/pr-preview" ]; then
+              echo "Preserving PR previews..."
+              cp -r gh-pages-temp/pr-preview ./build/
+              # Count actual PR preview directories (excluding parent)
+              preview_count=$(find ./build/pr-preview -mindepth 1 -maxdepth 1 -type d 2>/dev/null | wc -l)
+              echo "Preserved ${preview_count} PR preview(s)"
+            else
+              echo "No PR previews to preserve"
+            fi
+            
+            # Clean up temp directory
+            rm -rf gh-pages-temp
+          else
+            echo "No gh-pages branch found or unable to clone - this is normal for first deployment"
+          fi
+
       - name: Setup Pages
         uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
 
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -49,7 +49,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
-          lfs: false
+          lfs: false  # LFS not needed for code checks
           fetch-depth: 2
 
       - name: Setup dependencies
@@ -58,6 +58,7 @@ jobs:
           build: 'false'
 
       - name: Run ${{ matrix.check }}
+        timeout-minutes: 5
         run: ${{ matrix.command }}
         continue-on-error: ${{ matrix.continue-on-error || false }}
 
@@ -77,7 +78,7 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           fetch-depth: 1
-          lfs: false
+          lfs: false  # LFS not needed for markdown link checks
 
       - name: Check Markdown links (${{ matrix.extension }})
         uses: tcort/github-action-markdown-link-check@a800ad5f1c35bf61987946fd31c15726a1c9f2ba # v1.1.0
@@ -104,20 +105,16 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
-          lfs: true
+          lfs: true  # LFS required for building with images/assets
           fetch-depth: 2
 
       - name: Set base URL for build
         id: set-base-url
         run: |
           # Set base URL for PR preview builds (excluding Dependabot)
           if [ "${{ github.actor }}" != "dependabot[bot]" ]; then
-            # Validate PR number is numeric
+            # PR number is validated by GitHub and guaranteed to be numeric
             pr_number="${{ github.event.pull_request.number }}"
-            if ! [[ "$pr_number" =~ ^[0-9]+$ ]]; then
-              echo "Error: Invalid PR number: $pr_number"
-              exit 1
-            fi
             echo "build_base_url=/pr-preview/pr-${pr_number}/" >> $GITHUB_OUTPUT
             echo "Building with PR preview URL: /pr-preview/pr-${pr_number}/"
           else
@@ -136,7 +133,7 @@ jobs:
         with:
           name: build-artifacts
           path: ./build/
-          retention-days: 1
+          retention-days: 7  # Increased from 1 day for debugging purposes
           compression-level: 9
 
   # Deploy preview only for non-Dependabot PRs from the main repo (not forks)
@@ -158,7 +155,7 @@ jobs:
         with:
           ref: gh-pages
           fetch-depth: 1
-          lfs: false
+          lfs: false  # LFS not needed for gh-pages management
 
       - name: Download build artifacts
         uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
@@ -167,20 +164,21 @@ jobs:
           path: ./build/
 
       - name: Deploy preview to gh-pages
+        timeout-minutes: 5
         run: |
+          # Validate PR number is numeric
+          if [[ ! "${{ github.event.pull_request.number }}" =~ ^[0-9]+$ ]]; then
+            echo "Error: Invalid PR number: ${{ github.event.pull_request.number }}"
+            exit 1
+          fi
+
           # Configure git
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
 
           # Setup preview directory
           preview_dir="pr-preview/pr-${{ github.event.pull_request.number }}"
 
-          # Validate PR number and directory path
-          if ! [[ "${{ github.event.pull_request.number }}" =~ ^[0-9]+$ ]]; then
-            echo "Error: Invalid PR number: ${{ github.event.pull_request.number }}"
-            exit 1
-          fi
-
           # Ensure preview directory is within pr-preview folder
           if [[ "${preview_dir}" != pr-preview/pr-* ]]; then
             echo "Error: Invalid preview directory path: ${preview_dir}"
@@ -304,23 +302,24 @@ jobs:
         with:
           ref: gh-pages
           fetch-depth: 1
-          lfs: false
+          lfs: false  # LFS not needed for gh-pages management
 
       - name: Remove preview directory
+        timeout-minutes: 5
         run: |
+          # Validate PR number is numeric
+          if [[ ! "${{ github.event.pull_request.number }}" =~ ^[0-9]+$ ]]; then
+            echo "Error: Invalid PR number: ${{ github.event.pull_request.number }}"
+            exit 1
+          fi
+
           # Configure git
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
 
           # Remove preview directory
           preview_dir="pr-preview/pr-${{ github.event.pull_request.number }}"
 
-          # Validate PR number and directory path before removal
-          if ! [[ "${{ github.event.pull_request.number }}" =~ ^[0-9]+$ ]]; then
-            echo "Error: Invalid PR number: ${{ github.event.pull_request.number }}"
-            exit 1
-          fi
-
           # Ensure we're only removing from pr-preview folder
           if [[ "${preview_dir}" != pr-preview/pr-* ]]; then
             echo "Error: Invalid preview directory path: ${preview_dir}"
