- further improve table format, remove obsolete first column

- ensure flaky table is built only if enabled (but also if detailed is disabled)
mikepenz · Nov 3, 2024 · bc02967 · bc02967
1 parent d9c3594
commit bc02967
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 39 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/annotator.ts b/src/annotator.ts
@@ -130,7 +130,7 @@ export async function attachSummary(
   flakySummary: SummaryTableRow[]
 ): Promise<void> {
   await core.summary.addTable(table).write()
-  if (detailsTable.length > 0) {
+  if (detailsTable.length > 1) {
     await core.summary.addTable(detailsTable).write()
   }
   if (flakySummary.length > 1) {

diff --git a/src/table.ts b/src/table.ts
@@ -23,7 +23,6 @@ export function buildSummaryTables(
     ? []
     : [
         [
-          {data: '', header: true},
           {data: 'Test', header: true},
           {data: 'Result', header: true}
         ]
@@ -33,7 +32,6 @@ export function buildSummaryTables(
     ? []
     : [
         [
-          {data: '', header: true},
           {data: 'Test', header: true},
           {data: 'Retries', header: true}
         ]
@@ -48,23 +46,23 @@ export function buildSummaryTables(
       `${testResult.failed} failed`
     ])
 
-    if (detailedSummary) {
-      const annotations = testResult.globalAnnotations.filter(
-        annotation => includePassed || annotation.annotation_level !== 'notice'
-      )
+    const annotations = testResult.globalAnnotations.filter(
+      annotation => includePassed || annotation.annotation_level !== 'notice'
+    )
 
-      if (annotations.length === 0) {
-        if (!includePassed) {
-          core.info(
-            `⚠️ No annotations found for ${testResult.checkName}. If you want to include passed results in this table please configure 'include_passed' as 'true'`
-          )
-        }
-        detailsTable.push([`-`, `No test annotations available`, `-`])
-      } else {
+    if (annotations.length === 0) {
+      if (!includePassed) {
+        core.info(
+          `⚠️ No annotations found for ${testResult.checkName}. If you want to include passed results in this table please configure 'include_passed' as 'true'`
+        )
+      }
+      detailsTable.push([{data: `No test annotations available`, colspan: '2'}])
+    } else {
+      if (detailedSummary) {
+        detailsTable.push([{data: `${testResult.checkName}`, colspan: '2'}])
         if (!groupSuite) {
           for (const annotation of annotations) {
             detailsTable.push([
-              `${testResult.checkName}`,
               `${annotation.title}`,
               `${
                 annotation.status === 'success'
@@ -76,15 +74,19 @@ export function buildSummaryTables(
             ])
           }
         } else {
-          detailsTable.push([`${testResult.checkName}`, ``, ``])
           for (const internalTestResult of testResult.testResults) {
             appendDetailsTable(internalTestResult, detailsTable, includePassed)
           }
         }
       }
-      for (const annotation of annotations) {
-        if (annotation.retries > 0) {
-          flakyTable.push([`${testResult.checkName}`, `${annotation.title}`, `${annotation.retries}`])
+
+      if (flakySummary) {
+        const flakyAnnotations = annotations.filter(annotation => annotation.retries > 0)
+        if (flakyAnnotations.length > 0) {
+          flakyTable.push([{data: `${testResult.checkName}`, colspan: '2'}])
+          for (const annotation of flakyAnnotations) {
+            flakyTable.push([`${annotation.title}`, `${annotation.retries}`])
+          }
         }
       }
     }
@@ -101,9 +103,9 @@ function appendDetailsTable(
     annotation => includePassed || annotation.annotation_level !== 'notice'
   )
   if (annotations.length > 0) {
+    detailsTable.push([{data: `${testResult.name}`, colspan: '2'}])
     for (const annotation of annotations) {
       detailsTable.push([
-        `${testResult.name}`,
         `${annotation.title}`,
         `${
           annotation.status === 'success'