Merge pull request #1024 from mikepenz/feature/1020_2

Introduce setting to disable annotations for checks
mikepenz · Jan 29, 2024 · 2d2e937 · 2d2e937
2 parents b1b7f65 + 21fada7
commit 2d2e937
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -87,6 +87,7 @@ jobs:
 | `check_retries`         | Optional. If a testcase is retried, ignore the original failure.                                                                                             |
 | `check_title_template`  | Optional. Template to configure the title format. Placeholders: {{FILE_NAME}}, {{SUITE_NAME}}, {{TEST_NAME}}.                                                |
 | `summary`         | Optional. Additional text to summary output                                                                                                                        |
+| `check_annotations`         | Optional. Defines if the checks will include annotations. If disabled skips all annotations for the check. (This does not affect `annotate_only`, which uses no checks).      |
 | `update_check`    | Optional. Uses an alternative API to update checks, use for cases with more than 50 annotations. Default: `false`.                                                                  |
 | `annotate_only`   | Optional. Will only annotate the results on the files, won't create a check run. Defaults to `false`.                                                                                  |
 | `transformers`    | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]`                            |

diff --git a/action.yml b/action.yml
@@ -30,6 +30,10 @@ inputs:
     description: 'Enable to only annotate the results on the files, will not create a check run.'
     required: false
     default: 'false'
+  check_annotations:
+    description: 'Defines if the checks will include annotations (This is different than `annotate_only`).'
+    required: false
+    default: 'true'
   update_check:
     description: 'Defines if the active check should be updated instead'
     required: false

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
@@ -1,12 +1,14 @@
 import * as core from '@actions/core'
-import {TestResult} from './testParser'
+import {Annotation, TestResult} from './testParser'
 import * as github from '@actions/github'
 import {SummaryTableRow} from '@actions/core/lib/summary'
+import {GitHub} from '@actions/github/lib/utils'
 
 export async function annotateTestResult(
   testResult: TestResult,
   token: string,
   headSha: string,
+  checkAnnotations: boolean,
   annotateOnly: boolean,
   updateCheck: boolean,
   annotateNotice: boolean,
@@ -32,6 +34,7 @@ export async function annotateTestResult(
 
   const octokit = github.getOctokit(token)
   if (annotateOnly) {
+    // only create annotaitons, no check
     for (const annotation of annotations) {
       const properties: core.AnnotationProperties = {
         title: annotation.title,
@@ -50,6 +53,7 @@ export async function annotateTestResult(
       }
     }
   } else {
+    // check status is being created, annotations are included in this (if not diasbled by "checkAnnotations")
     if (updateCheck) {
       const checks = await octokit.rest.checks.listForRef({
         ...github.context.repo,
@@ -63,27 +67,20 @@ export async function annotateTestResult(
 
       const check_run_id = checks.data.check_runs[0].id
 
-      core.info(`ℹ️ - ${testResult.checkName} - Updating checks ${annotations.length}`)
-      for (let i = 0; i < annotations.length; i = i + 50) {
-        const sliced = annotations.slice(i, i + 50)
-
-        const updateCheckRequest = {
-          ...github.context.repo,
-          check_run_id,
-          output: {
-            title,
-            summary: testResult.summary,
-            annotations: sliced
-          }
+      if (checkAnnotations) {
+        core.info(`ℹ️ - ${testResult.checkName} - Updating checks (Annotations: ${annotations.length})`)
+        for (let i = 0; i < annotations.length; i = i + 50) {
+          const sliced = annotations.slice(i, i + 50)
+          updateChecks(octokit, check_run_id, title, testResult.summary, sliced)
         }
-
-        core.debug(JSON.stringify(updateCheckRequest, null, 2))
-
-        await octokit.rest.checks.update(updateCheckRequest)
+      } else {
+        core.info(`ℹ️ - ${testResult.checkName} - Updating checks (disabled annotations)`)
+        updateChecks(octokit, check_run_id, title, testResult.summary, [])
       }
     } else {
       const status: 'completed' | 'in_progress' | 'queued' | undefined = 'completed'
-
+      // don't send annotations if disabled
+      const adjsutedAnnotations = checkAnnotations ? annotations : []
       const createCheckRequest = {
         ...github.context.repo,
         name: testResult.checkName,
@@ -93,18 +90,39 @@ export async function annotateTestResult(
         output: {
           title,
           summary: testResult.summary,
-          annotations: annotations.slice(0, 50)
+          annotations: adjsutedAnnotations.slice(0, 50)
         }
       }
 
       core.debug(JSON.stringify(createCheckRequest, null, 2))
 
-      core.info(`ℹ️ - ${testResult.checkName} - Creating check for`)
+      core.info(`ℹ️ - ${testResult.checkName} - Creating check (Annotations: ${adjsutedAnnotations.length})`)
       await octokit.rest.checks.create(createCheckRequest)
     }
   }
 }
 
+async function updateChecks(
+  octokit: InstanceType<typeof GitHub>,
+  check_run_id: number,
+  title: string,
+  summary: string,
+  annotations: Annotation[]
+): Promise<void> {
+  const updateCheckRequest = {
+    ...github.context.repo,
+    check_run_id,
+    output: {
+      title,
+      summary,
+      annotations
+    }
+  }
+
+  core.debug(JSON.stringify(updateCheckRequest, null, 2))
+  await octokit.rest.checks.update(updateCheckRequest)
+}
+
 export async function attachSummary(
   testResults: TestResult[],
   detailedSummary: boolean,
@@ -158,8 +176,8 @@ export async function attachSummary(
               annotation.status === 'success'
                 ? '✅ pass'
                 : annotation.status === 'skipped'
-                ? `⏭️ skipped`
-                : `❌ ${annotation.annotation_level}`
+                  ? `⏭️ skipped`
+                  : `❌ ${annotation.annotation_level}`
             }`
           ])
         }

diff --git a/src/main.ts b/src/main.ts
@@ -16,6 +16,7 @@ export async function run(): Promise<void> {
 
     const annotateOnly = core.getInput('annotate_only') === 'true'
     const updateCheck = core.getInput('update_check') === 'true'
+    const checkAnnotations = core.getInput('check_annotations') === 'true'
     const commit = core.getInput('commit')
     const failOnFailure = core.getInput('fail_on_failure') === 'true'
     const requireTests = core.getInput('require_tests') === 'true'
@@ -109,7 +110,16 @@ export async function run(): Promise<void> {
 
     try {
       for (const testResult of testResults) {
-        await annotateTestResult(testResult, token, headSha, annotateOnly, updateCheck, annotateNotice, jobName)
+        await annotateTestResult(
+          testResult,
+          token,
+          headSha,
+          checkAnnotations,
+          annotateOnly,
+          updateCheck,
+          annotateNotice,
+          jobName
+        )
       }
     } catch (error) {
       core.error(`❌ Failed to create checks using the provided token. (${error})`)