Infrastructure: Workflow to auto-generate coverage and quality report…

… on merge (#2122) Closes #2061 * Updates github workflow * Adds last update date to report page --------- Co-authored-by: ariellalgilmore <[email protected]> Co-authored-by: Matt King <[email protected]>
w3c · Feb 20, 2024 · 16dbe83 · 16dbe83
1 parent e032502
commit 16dbe83
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 1 deletion.
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -9,12 +9,16 @@ on:
       - ".github/workflows/examples.yml"
       - "content/**/examples/**"
       - "scripts/reference-tables.*"
+      - "scripts/coverage-report.*"
+      - "coverage/**"
   pull_request:
     paths:
       - "package*.json"
       - ".github/workflows/examples.yml"
       - "content/**/examples/**"
       - "scripts/reference-tables.*"
+      - "scripts/coverage-report.*"
+      - "coverage/**"
 
 jobs:
   examples:
@@ -36,3 +40,23 @@ jobs:
 
       - name: Ensure no git changes
         run: git diff --exit-code
+
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate coverage files
+        run: npm run coverage-report
+
+      - name: Ensure no git changes
+        run: git diff --exit-code
diff --git a/content/about/coverage-and-quality/coverage-and-quality-report.html b/content/about/coverage-and-quality/coverage-and-quality-report.html
@@ -17,6 +17,7 @@
 <body>
   <main>
     <h1>Coverage and Quality Reports</h1>
+    <p>Page last updated: February 13, 2024</p>
     <section>
       <h2>About These Reports</h2>
       <p>

diff --git a/package.json b/package.json
@@ -17,6 +17,7 @@
     "lint:html": "npm run htmlhint && npm run vnu-jar",
     "lint:spelling": "cspell \"**/*.*\"",
     "link-checker": "node ./scripts/link-checker.js",
+    "coverage-report": "node scripts/coverage-report.js",
     "reference-tables": "node scripts/reference-tables.js",
     "regression": "ava --timeout=1m",
     "regression-report": "node test/util/report",
@@ -69,7 +70,9 @@
     ],
     "content/patterns/**/examples/*.html": [
       "npm run reference-tables",
-      "git add content/index/index.html"
+      "git add content/index/index.html",
+      "npm run coverage-report",
+      "git add coverage/"
     ]
   },
   "ava": {

diff --git a/scripts/coverage-report.js b/scripts/coverage-report.js
@@ -1138,12 +1138,26 @@ $('#example_summary_prototype').html(countPrototype);
 $('#example_summary_mouse').html(countMouse);
 $('#example_summary_pointer').html(countPointer);
 
+// Create a new Date object
+var currentDate = new Date();
+
+// Format the date as a string
+const formattedDate = currentDate.toLocaleDateString('en-US', {
+  day: 'numeric',
+  month: 'long',
+  year: 'numeric',
+});
+
 // cheerio seems to fold the doctype lines despite the template
 const result = $.html()
   .replace('<!DOCTYPE html>', '<!DOCTYPE html>\n')
   .replace(
     '<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">',
     '<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">\n'
+  )
+  .replace(
+    '<p>Page last updated: </p>',
+    `<p>Page last updated: ${formattedDate}</p>`
   );
 
 fs.writeFile(coverageReportPath, result, function (err) {

diff --git a/scripts/coverage-report.template b/scripts/coverage-report.template
@@ -18,6 +18,7 @@
 <body>
   <main>
     <h1>Coverage and Quality Reports</h1>
+    <p>Page last updated: </p>
     <section>
       <h2>About These Reports</h2>
       <p>