test: [M3-6876] - Improve formatting of GitHub test result comments (#…

…11200)

* Add optional title to GitHub comment, improve passing test headline

* Use HTML table for GitHub comment test result breakdown

* Change GitHub comment "Debugging" heading to "Troubleshooting"

* Added changeset: Slight improvements to GitHub test result comment formatting

packages/manager/.changeset/pr-11200-tests-1730467459621.md

@@ -0,0 +1,5 @@
+---
+"@linode/manager": Tests
+---
+
+Slight improvements to GitHub test result comment formatting ([#11200](https://github.com/linode/manager/pull/11200))

scripts/junit-summary/formatters/github-formatter.ts

@@ -23,11 +23,16 @@ export const githubFormatter: Formatter = (
   metadata: Metadata,
   _junitData: TestSuites[]
 ) => {
+  const title = !!metadata.pipelineTitle
+    ? `## ${metadata.pipelineTitle}`
+    : null;
+
   const headline = (() => {
-    const headingMarkdown = '## ';
+    const headingMarkdown = '### ';
+
     const description = runInfo.failing
-      ? `${runInfo.failing} failing ${pluralize(runInfo.failing, 'test', 'tests')} on`
-      : `Passing`;
+      ? `:small_red_triangle: ${runInfo.failing} failing ${pluralize(runInfo.failing, 'test', 'tests')} on`
+      : `:tada: ${runInfo.passing} passing ${pluralize(runInfo.passing, 'test', 'tests')} on`;
 
     // If available, render a link for the run.
     const runLink = (metadata.runId && metadata.runUrl)
@@ -37,12 +42,28 @@ export const githubFormatter: Formatter = (
     return `${headingMarkdown}${description} ${runLink}`;
   })();
 
-  const breakdown = `:x: ${runInfo.failing} Failing | :green_heart: ${runInfo.passing} Passing | :arrow_right_hook: ${runInfo.skipped} Skipped | :clock1: ${secondsToTimeString(runInfo.time)}\n\n`;
+  const breakdown = [
+    '<table>',
+    '<thead><tr>',
+    '<td><strong>:x: Failing</strong></td>',
+    '<td><strong>:white_check_mark: Passing</strong></td>',
+    '<td><strong>:arrow_right_hook: Skipped</strong></td>',
+    '<td><strong>:clock1: Duration</strong></td>',
+    '</tr></thead>',
+    '<tbody><tr>',
+    `<td><code>${runInfo.failing} Failing</code></td>`,
+    `<td><code>${runInfo.passing} Passing</code></td>`,
+    `<td><code>${runInfo.skipped} Skipped</code></td>`,
+    `<td><code>${secondsToTimeString(runInfo.time)}</code></td>`,
+    '</tr></tbody>',
+    '</table>',
+    '\n\n',
+  ].join('');
 
   const extra = metadata.extra ? `${metadata.extra}\n\n` : null;
 
   const failedTestSummary = (() => {
-    const heading = `### Details`;
+    const heading = `#### Details`;
     const failedTestHeader = `<table><thead><tr><th colspan="3">Failing Tests</th></tr><tr><th></th><th>Spec</th><th>Test</th></tr></thead><tbody>`;
     const failedTestRows = results
       .filter((result: TestResult) => result.failing)
@@ -62,7 +83,7 @@ export const githubFormatter: Formatter = (
   })();
 
   const rerunNote = (() => {
-    const heading = `### Debugging`;
+    const heading = `#### Troubleshooting`;
     const failingTestFiles = results
       .filter((result: TestResult) => result.failing)
       .map((result: TestResult) => result.testFilename);
@@ -81,6 +102,7 @@ export const githubFormatter: Formatter = (
   })();
 
   return [
+    title,
     headline,
     '',
     breakdown,