Merge pull request #657 from shawnthompson/shawn-fix-deploy

refactor: consolidate GitHub Actions workflow for analytics update and deploy

Author: shawnthompson

.github/workflows/gh-pages.yml

@@ -1,16 +1,17 @@
 name: Deploy and Update Analytics
 
 on:
-  push:
-    branches:
-      - main
   schedule:
     - cron: '0 0 * * *'  # Runs every day at midnight UTC
   workflow_dispatch:  # Allows manual triggering
+  pull_request:
+    types: [closed]
+    branches:
+      - main
 
 jobs:
-  update-analytics:
-    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+  update-analytics-and-deploy:
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true && github.ref == 'refs/heads/main')
     runs-on: ubuntu-latest
     environment: github-pages  # Specify the environment here
     steps:
@@ -31,46 +32,14 @@ jobs:
           GOOGLE_REFRESH_TOKEN: ${{ secrets.GOOGLE_REFRESH_TOKEN }}
           PROPERTY_ID: ${{ secrets.PROPERTY_ID }}
 
-  deploy:
-    if: github.event_name == 'push'
-    runs-on: ubuntu-latest
-    environment: github-pages  # Specify the environment here
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: 'main'
-          fetch-depth: '0'
-
-      - name: Setup Node
-        uses: actions/setup-node@v2.1.2
-        with:
-          node-version: '20.x'
-
-      - name: Reconfigure git to use HTTP authentication
-        run: >
-            git config --global url."https://github.com/".insteadOf
-            ssh://git@github.com/
-
-      - name: Cache dependencies
-        uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - run: npm ci
-      - run: npm run build
-        env:
-          GOOGLE_CLIENT_ID: ${{ secrets.GOOGLE_CLIENT_ID }}
-          GOOGLE_CLIENT_SECRET: ${{ secrets.GOOGLE_CLIENT_SECRET }}
-          GOOGLE_REFRESH_TOKEN: ${{ secrets.GOOGLE_REFRESH_TOKEN }}
-          PROPERTY_ID: ${{ secrets.PROPERTY_ID }}
+      - name: Build site
+        run: npm run build
 
-      - name: Deploy
+      - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./_site
           user_name: 'github-actions[bot]'
           user_email: 'github-actions[bot]@users.noreply.github.com'
+          publish_branch: gh-pages

.gitignore

@@ -1,4 +1,4 @@
-# Analytics file created on build
+# Ignore analytics.json to prevent frequent commits
 src/_data/analytics.json
 
 # Logs

package.json

@@ -19,9 +19,9 @@
     "start": "cross-env ELEVENTY_WATCH=true ELEVENTY_ENV=local npm-run-all sass-start serve:port --parallel watch:*",
     "start-dev": "cross-env ELEVENTY_WATCH=true ELEVENTY_ENV=dev npm-run-all sass-start serve:port --parallel watch:*",
     "start-prod": "cross-env ELEVENTY_WATCH=true ELEVENTY_ENV=prod npm-run-all sass-start serve:port --parallel watch:*",
-    "dev": "cross-env ELEVENTY_ENV=dev npm-run-all analytics sass-build --parallel eleventy",
+    "dev": "cross-env ELEVENTY_ENV=dev npm-run-all sass-build --parallel eleventy",
     "debug": "DEBUG=Eleventy* npx @11ty/eleventy",
-    "build": "npm-run-all analytics sass-build eleventy"
+    "build": "npm-run-all sass-build eleventy"
   },
   "repository": {
     "type": "git",

scripts/fetch-analytics.js

@@ -1,3 +1,8 @@
+// Generate analytics.json script
+// Note: This script requires Google Analytics API keys to successfully run.
+// If you intend to update or regenerate the analytics.json file, ensure you have the following keys available in your local .env file:
+// GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, GOOGLE_REFRESH_TOKEN, PROPERTY_ID
+
 const { google } = require('googleapis');
 const analyticsData = google.analyticsdata('v1beta');
 require('dotenv').config();