Merge pull request #1289 from mikepenz/feature/add_verbose_summary_flag

Add new config to disable the verbose summary

Author: mikepenz

README.md

@@ -95,7 +95,8 @@ jobs:
 | `transformers`             | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]`                                                             |
 | `job_summary`              | Optional. Enables the publishing of the job summary for the results. Defaults to `true`. May be required to disable [Enterprise Server](https://github.com/mikepenz/action-junit-report/issues/637) |
 | `detailed_summary`         | Optional. Include table with all test results in the summary. Defaults to `false`.                                                                                                                  |
-| `flaky_summary`            | Optional. Include table with all falky results in the summary. Defaults to `false`.                                                                                                                 |
+| `flaky_summary`            | Optional. Include table with all flaky results in the summary. Defaults to `false`.                                                                                                                 |
+| `verbose_summary`          | Optional. Detail table will note if there were no test annotations for a test suite. Defaults to `true`.                                                                                            |
 | `group_suite`              | Optional. If enabled, will group the testcases by test suite in the `detailed_summary`. Defaults to `false`.                                                                                        |
 | `comment`                  | Optional. Enables a comment being added to the PR with the summary tables (Respects the summary configuration flags). Defaults to `false`.                                                          |
 | `updateComment`            | Optional. If a prior action run comment exists, it is updated. If disabled, new comments are creted for each run. Defaults to `true`.                                                               |

__tests__/table.test.ts

@@ -59,7 +59,7 @@ describe('buildSummaryTables', () => {
       '/'
     )
 
-    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true)
+    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true)
 
     expect(table).toStrictEqual(NORMAL_TABLE)
     expect(detailTable).toStrictEqual([
@@ -100,7 +100,7 @@ describe('buildSummaryTables', () => {
       '/'
     )
 
-    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true)
+    const [table, detailTable, flakyTable] = buildSummaryTables([testResult], true, true, true, true, true)
 
     expect(table).toStrictEqual(NORMAL_TABLE)
     expect(detailTable).toStrictEqual([

action.yml

@@ -94,6 +94,10 @@ inputs:
     description: 'Include table with all flaky results in summary'
     required: false
     default: 'false'
+  verbose_summary:
+    description: 'Include note of missing test annotations in summary.'
+    required: false
+    default: 'true'
   group_suite:
     description: 'If enabled, will group the testcases by test suite in the `detailed_summary`'
     required: false

dist/index.js

@@ -160,7 +160,7 @@ export async function attachComment(
   const identifier = buildCommentIdentifier(checkName)
 
   let comment = buildTable(table)
-  if (detailsTable.length > 0) {
+  if (detailsTable.length > 1) {
     comment += '\n\n'
     comment += buildTable(detailsTable)
   }

dist/index.js.map

@@ -31,6 +31,7 @@ export async function run(): Promise<void> {
     const jobSummary = core.getInput('job_summary') === 'true'
     const detailedSummary = core.getInput('detailed_summary') === 'true'
     const flakySummary = core.getInput('flaky_summary') === 'true'
+    const verboseSummary = core.getInput('verbose_summary') === 'true'
     const groupSuite = core.getInput('group_suite') === 'true'
     const comment = core.getInput('comment') === 'true'
     const updateComment = core.getInput('updateComment') === 'true'
@@ -155,6 +156,7 @@ export async function run(): Promise<void> {
       includePassed,
       detailedSummary,
       flakySummary,
+      verboseSummary,
       groupSuite
     )
     if (jobSummary && supportsJobSummary) {

src/annotator.ts

@@ -8,6 +8,7 @@ export function buildSummaryTables(
   includePassed: boolean,
   detailedSummary: boolean,
   flakySummary: boolean,
+  verboseSummary: boolean,
   groupSuite = false
 ): [SummaryTableRow[], SummaryTableRow[], SummaryTableRow[]] {
   // only include a warning icon if there are skipped tests
@@ -67,7 +68,9 @@ export function buildSummaryTables(
           `⚠️ 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'}])
+      if (verboseSummary) {
+        detailsTable.push([{data: `No test annotations available`, colspan: '2'}])
+      }
     } else {
       if (detailedSummary) {
         detailsTable.push([{data: `<strong>${testResult.checkName}</strong>`, colspan: '2'}])