Lighthouse: Added workflow to generate the main report artifact on push to main

Author: lamATnginx

.github/workflows/build-push.yml

@@ -41,9 +41,19 @@ jobs:
             node-version: 18
         - name: Installing packages
           run: cd performance && npm ci
-        - name: Generating lighthouse reports for PR and main...
+        - name: Generating lighthouse reports for PR...
+          env: 
+            REPORT_NAME: "pr"
           run: | 
               node performance/lighthouse-script.js
+        - name: Download the artifact for main
+          uses: actions/download-artifact@v3
+          with:
+            name: lighthouse-reports
+            path: ./main-report
+        - name: Move the main report artifact to same directory as pr report
+          run: |
+            mv ./main-report/main-report.json ./lighthouse-reports
         - name: Compare the artifacts for negative differences in performance
           continue-on-error: true
           run: |
@@ -72,4 +82,4 @@ jobs:
           with:
               name: lighthouse-reports
               path: lighthouse-reports/
-              retention-days: 30
+              retention-days: 3

.github/workflows/lighthouse.yml

@@ -0,0 +1,43 @@
+name: Update lighthouse report artifact for main branch
+
+on: 
+  push:
+    branches: 
+      - main
+  workflow_dispatch:
+
+env:
+  OWNER: nginxinc
+  REPO: nginx-hugo-theme
+jobs:
+  generate-lighthouse-report:
+    runs-on: ubuntu-22.04
+    steps:
+        - uses: actions/checkout@v5
+          with:
+            ref: ${{ github.event.workflow_run.head_branch }}
+        - uses: actions/setup-node@v5
+          with:
+            node-version: 18
+        - name: Installing packages
+          run: cd performance && npm ci
+        - name: Get PR number being merged
+          run: |
+            RESPONSE=$(curl -L \
+              -X GET \
+              -H "Accept: application/vnd.github+json" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              -s "https://api.github.com/repos/${{ env.OWNER }}/${{ env.REPO }}/pulls?state=closed&direction=desc&page=1&per_page=5")
+            LATEST_PR_NUMBER=$(echo "$RESPONSE" | jq -r '.[] | select(.merged_at != null) | .number' | head -1)
+            echo "GITHUB_PR_NUMBER=$LATEST_PR_NUMBER" >> $GITHUB_ENV
+        - name: Generating lighthouse reports for main...
+          env: 
+            REPORT_NAME: "main"
+            GITHUB_PR_NUMBER: ${{ env.GITHUB_PR_NUMBER }}
+          run: |
+            node performance/lighthouse-script.js
+        - uses: actions/upload-artifact@v4
+          with:
+            name: lighthouse-reports
+            path: lighthouse-reports/
+            retention-days: 30

performance/lighthouse-script.js

@@ -2,14 +2,9 @@ const puppeteer = require('puppeteer');
 const fs = require('fs');
 
 const PORT = 8041;
+const REPORT_NAME = process.env.REPORT_NAME;
 const PR_NUMBER = process.env.GITHUB_PR_NUMBER;
 const OUTPUT_DIR = './lighthouse-reports';
-const ENVIRONMENTS = [
-  {
-    title: 'pr',
-    url: `https://frontdoor-test-docs.nginx.com/previews/nginx-hugo-theme/${PR_NUMBER}/`,
-  },
-];
 
 const signIntoFrontDoor = async (browser, env) => {
   const page = await browser.newPage();
@@ -36,21 +31,26 @@ const generateLighthouseReport = async (env) => {
   console.log(`Generated report for ${env['title']}...`);
 };
 
-(async () => {
-  const browser = await puppeteer.launch({
+const launchBrowser = async () => {
+  return await puppeteer.launch({
     args: [`--remote-debugging-port=${PORT}`],
     headless: true,
   });
+};
+
+(async () => {
+  const browser = await launchBrowser();
   if (!fs.existsSync(OUTPUT_DIR)) {
     fs.mkdirSync(OUTPUT_DIR);
   }
 
-  for (const env of ENVIRONMENTS) {
-    if (env['title'] === 'pr') {
-      await signIntoFrontDoor(browser, env);
-    }
-    await generateLighthouseReport(env);
-  }
+  const environment = {
+    title: `${REPORT_NAME}`,
+    url: `https://frontdoor-test-docs.nginx.com/previews/nginx-hugo-theme/${PR_NUMBER}/`,
+  };
+
+  await signIntoFrontDoor(browser, environment);
+  await generateLighthouseReport(environment);
 
   browser.close();
 })();