Merge pull request #1167 from mikepenz/feature/1166

Introduce flag to comment summary on PR

.github/workflows/build.yml

@@ -54,6 +54,7 @@ jobs:
           report_paths: test_results/python/report_flaky.xml
           include_passed: true
           detailed_summary: true
+          comment: true
           annotate_only: ${{ github.event_name == 'workflow_dispatch' }}
 
       - name: Test JUnit flaky test import

README.md

@@ -96,6 +96,8 @@ jobs:
 | `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`.                                                                                                                 |
+| `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`. |
 | `annotate_notice`       | Optional. Annotate passed test results along with warning/failed ones. Defaults to `false`. (Changed in v3.5.0)                                                                                     |
 | `follow_symlink`        | Optional. Enables to follow symlinks when searching test files via the globber. Defaults to `false`.                                                                                                |
 | `job_name`              | Optional. Specify the name of a check to update                                                                                                                                                     |
@@ -164,6 +166,7 @@ configuration) please enable `write` permission via:
 ```yml
 permissions:
   checks: write
+  pull-requests: write # only required if `comment: true` was enabled
 ```
 
 Additionally for [security reasons], the github token used for `pull_request` workflows is [marked as read-only].

action.yml

@@ -90,6 +90,14 @@ inputs:
     description: 'Include table with all flaky results in summary'
     required: false
     default: 'false'
+  comment:
+    description: 'Enables a comment being added to the PR with the summary tables (summary has to be enabled). Default: false'
+    required: false
+    default: 'false'
+  updateComment:
+    description: 'Enables updating the prior comment if one already exists. Default: true'
+    required: false
+    default: 'true'
   annotate_notice:
     description: 'Annotate passed tests along with warning and failed ones'
     required: false

src/annotator.ts

@@ -2,7 +2,8 @@ import * as core from '@actions/core'
 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'
+import {context, GitHub} from '@actions/github/lib/utils'
+import {buildTable} from './utils'
 
 export async function annotateTestResult(
   testResult: TestResult,
@@ -216,3 +217,57 @@ export async function attachSummary(
     await core.summary.addTable(flakySummary).write()
   }
 }
+
+export function buildCommentIdentifier(checkName: string[]): string {
+  return `<!-- Summary comment for ${JSON.stringify(checkName)} by mikepenz/action-junit-report -->`
+}
+
+export async function attachComment(
+  octokit: InstanceType<typeof GitHub>,
+  checkName: string[],
+  updateComment: boolean,
+  table: SummaryTableRow[],
+  detailsTable: SummaryTableRow[],
+  flakySummary: SummaryTableRow[]
+): Promise<void> {
+  const identifier = buildCommentIdentifier(checkName)
+
+  let comment = buildTable(table)
+  if (detailsTable.length > 0) {
+    comment += '\n\n'
+    comment += buildTable(detailsTable)
+  }
+  if (flakySummary.length > 1) {
+    comment += '\n\n'
+    comment += buildTable(flakySummary)
+  }
+  comment += `\n\n${identifier}`
+
+  const priorComment = updateComment ? await findPriorComment(octokit, identifier) : undefined
+  if (priorComment) {
+    await octokit.rest.issues.updateComment({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      comment_id: priorComment,
+      body: comment
+    })
+  } else {
+    await octokit.rest.issues.createComment({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      issue_number: context.issue.number,
+      body: comment
+    })
+  }
+}
+
+async function findPriorComment(octokit: InstanceType<typeof GitHub>, identifier: string): Promise<number | undefined> {
+  const comments = await octokit.paginate(octokit.rest.issues.listComments, {
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    issue_number: context.issue.number
+  })
+
+  const foundComment = comments.find(comment => comment.body?.endsWith(identifier))
+  return foundComment?.id
+}

src/main.ts

@@ -1,8 +1,9 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {annotateTestResult, attachSummary, buildSummaryTables} from './annotator'
+import {annotateTestResult, attachComment, attachSummary, buildSummaryTables} from './annotator'
 import {parseTestReports, TestResult} from './testParser'
 import {buildTable, readTransformers, retrieve} from './utils'
+import {GitHub} from '@actions/github/lib/utils'
 
 export async function run(): Promise<void> {
   try {
@@ -27,6 +28,8 @@ 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 comment = core.getInput('comment') === 'true'
+    const updateComment = core.getInput('updateComment') === 'true'
     const jobName = core.getInput('job_name')
 
     const reportPaths = core.getMultilineInput('report_paths')
@@ -150,6 +153,11 @@ export async function run(): Promise<void> {
       core.info('⏩ Skipped creation of job summary')
     }
 
+    if (comment) {
+      const octokit: InstanceType<typeof GitHub> = github.getOctokit(token)
+      attachComment(octokit, checkName, updateComment, table, detailTable, flakyTable)
+    }
+
     core.setOutput('summary', buildTable(table))
     core.setOutput('detailed_summary', buildTable(detailTable))
     core.setOutput('flaky_summary', buildTable(flakyTable))