PR comment functionality (draft)

Author: bigdaz

.github/workflows/demo-job-summary.yml

@@ -3,6 +3,7 @@ name: Demo Job Summary, for Gradle builds
 on:
   workflow_dispatch:
   push:
+  pull_request:
 
 env:
   GRADLE_BUILD_ACTION_CACHE_DEBUG_ENABLED: true
@@ -20,6 +21,8 @@ jobs:
         npm run build
     - name: Setup Gradle
       uses: ./
+      with:
+        add-pr-comment: true
     - name: Build kotlin-dsl project
       working-directory: .github/workflow-samples/kotlin-dsl
       run: ./gradlew assemble
@@ -60,6 +63,8 @@ jobs:
         touch ~/.gradle/caches/dummy.txt
     - name: Setup Gradle
       uses: ./
+      with:
+        add-pr-comment: true
     - name: Run build
       working-directory: .github/workflow-samples/groovy-dsl
       run: ./gradlew assemble

action.yml

@@ -63,6 +63,11 @@ inputs:
     required: false
     default: true
 
+  add-pr-comment:
+    description: When 'true', a summary of the Gradle builds will be added as a PR comment. No action will be taken if the workflow was not triggered from a pull request.
+    required: false
+    default: false
+
   dependency-graph:
     description: Specifies if a GitHub dependency snapshot should be generated for each Gradle build, and if so, how. Valid values are 'disabled' (default), 'generate', 'generate-and-submit', 'generate-and-upload' and 'download-and-submit'.
     required: false

src/input-params.ts

@@ -71,6 +71,10 @@ export function isJobSummaryEnabled(): boolean {
     return getBooleanInput('generate-job-summary', true)
 }
 
+export function isPRCommentEnabled(): boolean {
+    return getBooleanInput('add-pr-comment', false)
+}
+
 export function isDependencyGraphEnabled(): boolean {
     return getBooleanInput('generate-dependency-graph', true)
 }

src/job-summary.ts

@@ -1,4 +1,5 @@
 import * as core from '@actions/core'
+import * as github from '@actions/github'
 import {SUMMARY_ENV_VAR} from '@actions/core/lib/summary'
 
 import * as params from './input-params'
@@ -10,6 +11,8 @@ export async function generateJobSummary(buildResults: BuildResult[], cacheListe
     const cachingReport = generateCachingReport(cacheListener)
 
     if (shouldGenerateJobSummary()) {
+        core.info('Generating Job Summary')
+
         core.summary.addRaw(summaryTable)
         core.summary.addRaw(cachingReport)
         await core.summary.write()
@@ -20,6 +23,36 @@ export async function generateJobSummary(buildResults: BuildResult[], cacheListe
         core.info(cachingReport)
         core.info('============================')
     }
+
+    if (shouldAddPRComment()) {
+        await addPRComment(summaryTable)
+    }
+}
+
+async function addPRComment(content: string): Promise<void> {
+    try {
+        const github_token = params.getGithubToken()
+
+        const context = github.context
+        if (context.payload.pull_request == null) {
+            core.info('Not a PR')
+            core.info(`Issue number: ${context.issue.number}`)
+            core.info(`Context payload: ${JSON.stringify(context.payload)}`)
+            return
+        }
+
+        const pull_request_number = context.payload.pull_request.number
+        core.info(`Adding Job Summary as comment to PR #${pull_request_number}.`)
+
+        const octokit = github.getOctokit(github_token)
+        await octokit.rest.issues.createComment({
+            ...context.repo,
+            issue_number: pull_request_number,
+            body: content
+        })
+    } catch (error) {
+        core.warning(`Failed to generate PR comment: ${String(error)}`)
+    }
 }
 
 function renderSummaryTable(results: BuildResult[]): string {
@@ -84,3 +117,7 @@ function shouldGenerateJobSummary(): boolean {
 
     return params.isJobSummaryEnabled()
 }
+
+function shouldAddPRComment(): boolean {
+    return params.isPRCommentEnabled()
+}