Merge pull request #1355 from mikepenz/feature/1352

Add link to check in summary

Author: mikepenz

__tests__/testParser.test.ts

@@ -1452,12 +1452,12 @@ describe('parseTestReports', () => {
 
     // Filter to only failure annotations for easier verification
     const failureAnnotations = globalAnnotations.filter(annotation => annotation.annotation_level === 'failure')
-    
+
     // Should have 4 failure annotations total: 3 from testWithMultipleFailures + 1 from testWithSingleFailure
     expect(failureAnnotations).toHaveLength(4)
 
     // Verify the multiple failures test case creates separate annotations
-    const multipleFailuresAnnotations = failureAnnotations.filter(annotation => 
+    const multipleFailuresAnnotations = failureAnnotations.filter(annotation =>
       annotation.title.includes('testWithMultipleFailures')
     )
     expect(multipleFailuresAnnotations).toHaveLength(3)
@@ -1479,7 +1479,7 @@ describe('parseTestReports', () => {
     expect(multipleFailuresAnnotations[2].start_line).toBe(25)
 
     // Verify the single failure test case (should not have failure index in title)
-    const singleFailureAnnotations = failureAnnotations.filter(annotation => 
+    const singleFailureAnnotations = failureAnnotations.filter(annotation =>
       annotation.title.includes('testWithSingleFailure')
     )
     expect(singleFailureAnnotations).toHaveLength(1)

dist/index.js

@@ -3,7 +3,12 @@ import {Annotation, TestResult} from './testParser.js'
 import * as github from '@actions/github'
 import {SummaryTableRow} from '@actions/core/lib/summary.js'
 import {context, GitHub} from '@actions/github/lib/utils.js'
-import {buildTable} from './utils.js'
+import {buildLink, buildList, buildTable} from './utils.js'
+
+export interface CheckInfo {
+  name: string
+  url: string
+}
 
 export async function annotateTestResult(
   testResult: TestResult,
@@ -14,7 +19,7 @@ export async function annotateTestResult(
   updateCheck: boolean,
   annotateNotice: boolean,
   jobName: string
-): Promise<void> {
+): Promise<CheckInfo | undefined> {
   const annotations = testResult.globalAnnotations.filter(
     annotation => annotateNotice || annotation.annotation_level !== 'notice'
   )
@@ -53,6 +58,7 @@ export async function annotateTestResult(
         core.notice(annotation.message, properties)
       }
     }
+    return undefined // No check created, so no URL to return
   } else {
     // check status is being created, annotations are included in this (if not diasbled by "checkAnnotations")
     if (updateCheck) {
@@ -67,6 +73,7 @@ export async function annotateTestResult(
       core.debug(JSON.stringify(checks, null, 2))
 
       const check_run_id = checks.data.check_runs[0].id
+      const checkUrl = `https://github.com/${github.context.repo.owner}/${github.context.repo.repo}/runs/${check_run_id}`
 
       if (checkAnnotations) {
         core.info(`ℹ️ - ${testResult.checkName} - Updating checks (Annotations: ${annotations.length})`)
@@ -78,6 +85,11 @@ export async function annotateTestResult(
         core.info(`ℹ️ - ${testResult.checkName} - Updating checks (disabled annotations)`)
         await updateChecks(octokit, check_run_id, title, testResult.summary, [])
       }
+
+      return {
+        name: testResult.checkName,
+        url: checkUrl
+      }
     } else {
       const status: 'completed' | 'in_progress' | 'queued' | undefined = 'completed'
       // don't send annotations if disabled
@@ -98,7 +110,13 @@ export async function annotateTestResult(
       core.debug(JSON.stringify(createCheckRequest, null, 2))
 
       core.info(`ℹ️ - ${testResult.checkName} - Creating check (Annotations: ${adjustedAnnotations.length})`)
-      await octokit.rest.checks.create(createCheckRequest)
+      const checkResponse = await octokit.rest.checks.create(createCheckRequest)
+
+      // Return the check URL for use in job summary
+      return {
+        name: testResult.checkName,
+        url: `https://github.com/${github.context.repo.owner}/${github.context.repo.repo}/runs/${checkResponse.data.id}`
+      }
     }
   }
 }
@@ -127,7 +145,8 @@ async function updateChecks(
 export async function attachSummary(
   table: SummaryTableRow[],
   detailsTable: SummaryTableRow[],
-  flakySummary: SummaryTableRow[]
+  flakySummary: SummaryTableRow[],
+  checkInfos: CheckInfo[] = []
 ): Promise<void> {
   if (table.length > 0) {
     await core.summary.addTable(table).write()
@@ -138,6 +157,16 @@ export async function attachSummary(
   if (flakySummary.length > 1) {
     await core.summary.addTable(flakySummary).write()
   }
+
+  // Add check links to the job summary if any checks were created
+  if (checkInfos.length > 0) {
+    const links = checkInfos.map(checkInfo => {
+      return buildLink(`View ${checkInfo.name}`, checkInfo.url)
+    })
+    core.summary.addList(links)
+  }
+  core.summary.addSeparator()
+  core.summary.write()
 }
 
 export function buildCommentIdentifier(checkName: string[]): string {
@@ -150,7 +179,8 @@ export async function attachComment(
   updateComment: boolean,
   table: SummaryTableRow[],
   detailsTable: SummaryTableRow[],
-  flakySummary: SummaryTableRow[]
+  flakySummary: SummaryTableRow[],
+  checkInfos: CheckInfo[] = []
 ): Promise<void> {
   if (!context.issue.number) {
     core.warning(`⚠️ Action requires a valid issue number (PR reference) to be able to attach a comment..`)
@@ -173,6 +203,16 @@ export async function attachComment(
     comment += '\n\n'
     comment += buildTable(flakySummary)
   }
+
+  // Add check links to the job summary if any checks were created
+  if (checkInfos.length > 0) {
+    const links = checkInfos.map(checkInfo => {
+      return buildLink(`View ${checkInfo.name}`, checkInfo.url)
+    })
+    comment += buildList(links)
+    comment += `\n\n`
+  }
+
   comment += `\n\n${identifier}`
 
   const priorComment = updateComment ? await findPriorComment(octokit, identifier) : undefined

dist/index.js.map

@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {annotateTestResult, attachComment, attachSummary} from './annotator.js'
+import {annotateTestResult, attachComment, attachSummary, CheckInfo} from './annotator.js'
 import {parseTestReports, TestResult} from './testParser.js'
 import {buildTable, readTransformers, retrieve} from './utils.js'
 import {GitHub} from '@actions/github/lib/utils.js'
@@ -155,10 +155,11 @@ export async function run(): Promise<void> {
     core.endGroup()
     core.startGroup(`🚀 Publish results`)
 
+    const checkInfos: CheckInfo[] = []
     if (!skipAnnotations) {
       try {
         for (const testResult of testResults) {
-          await annotateTestResult(
+          const checkInfo = await annotateTestResult(
             testResult,
             token,
             headSha,
@@ -168,6 +169,9 @@ export async function run(): Promise<void> {
             annotateNotice,
             jobName
           )
+          if (checkInfo) {
+            checkInfos.push(checkInfo)
+          }
         }
       } catch (error) {
         core.error(`❌ Failed to create checks using the provided token. (${error})`)
@@ -192,7 +196,7 @@ export async function run(): Promise<void> {
     )
     if (jobSummary && supportsJobSummary) {
       try {
-        await attachSummary(table, detailTable, flakyTable)
+        await attachSummary(table, detailTable, flakyTable, checkInfos)
       } catch (error) {
         core.error(`❌ Failed to set the summary using the provided token. (${error})`)
       }
@@ -204,7 +208,7 @@ export async function run(): Promise<void> {
 
     if (comment && (!skipCommentWithoutTests || mergedResult.totalCount > 0)) {
       const octokit: InstanceType<typeof GitHub> = github.getOctokit(token)
-      await attachComment(octokit, checkName, updateComment, table, detailTable, flakyTable)
+      await attachComment(octokit, checkName, updateComment, table, detailTable, flakyTable, checkInfos)
     }
 
     core.setOutput('summary', buildTable(table))