Merge pull request #246 from GSA/5701-automate-lighthouse

Light House Config (WIP)

Author: cmhedrickREI

.github/workflows/commit.yml

@@ -133,4 +133,4 @@ jobs:
           smoke-url: https://catalog-dev.data.gov/
           smoke-path: /
           basic_auth_user: ${{ secrets.BASIC_AUTH_USER }}
-          basic_auth_password: ${{ secrets.BASIC_AUTH_PASSWORD }}
+          basic_auth_password: ${{ secrets.BASIC_AUTH_PASSWORD }}

.github/workflows/deploy.yml

@@ -58,3 +58,52 @@ jobs:
           smoke-url: https://catalog.data.gov/
           smoke-path: /
           # basic auth on prod is turned off
+
+  lighthouse:
+    name: Lighthouse CI Audit
+    needs: deploy-prod
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install Lighthouse CI
+        run: npm install -g @lhci/cli
+
+      - name: Collect Lighthouse results
+        run: |
+          lhci collect \
+            --url="https://catalog.data.gov" \
+            --url="https://catalog.data.gov/organization" \
+            --url="https://catalog.data.gov/organization/gsa" \
+            --url="https://catalog.data.gov/dataset/gsa-enterprise-data-inventory-edi" \
+            --numberOfRuns=1
+
+      - name: Upload to filesystem
+        run: |
+          lhci upload \
+            --target=filesystem \
+            --outputDir=./lighthouse-results
+
+      - name: Assert thresholds
+        run: |
+          output=$(lhci assert --config=lighthouserc.yml 2>&1) || {
+            echo "$output" | while IFS= read -r line; do
+              [[ -n "$line" ]] && echo "::error::$line"
+            done
+            exit 1
+          }
+
+      - name: Upload Lighthouse results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: lighthouse-results
+          path: ./lighthouse-results/**/*.html
+          retention-days: 7

lighthouserc.yml

@@ -0,0 +1,15 @@
+ci:
+  assert:
+    assertions:
+      categories:performance:
+        - error
+        - minScore: 0.4
+      categories:accessibility:
+        - error
+        - minScore: 0.75
+      categories:best-practices:
+        - error
+        - minScore: 0.75
+      categories:seo:
+        - error
+        - minScore: 0.75