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' import {BuildResult} from './build-results' import {CacheListener, generateCachingReport} from './cache-reporting' export async function generateJobSummary(buildResults: BuildResult[], cacheListener: CacheListener): Promise { const summaryTable = renderSummaryTable(buildResults) const cachingReport = generateCachingReport(cacheListener) if (shouldGenerateJobSummary()) { core.info('Generating Job Summary') core.summary.addRaw(summaryTable) core.summary.addRaw(cachingReport) await core.summary.write() } else { core.info('============================') core.info(summaryTable) core.info('============================') core.info(cachingReport) core.info('============================') } if (shouldAddPRComment()) { await addPRComment(summaryTable) } } async function addPRComment(jobSummary: string): Promise { try { const github_token = params.getGithubToken() const context = github.context if (context.payload.pull_request == null) { core.info('No pull_request trigger: not adding PR comment') return } const pull_request_number = context.payload.pull_request.number core.info(`Adding Job Summary as comment to PR #${pull_request_number}.`) const prComment = `

Job Summary for gradle-build-action

${github.context.workflow} :: ${github.context.job}
${jobSummary}` const octokit = github.getOctokit(github_token) await octokit.rest.issues.createComment({ ...context.repo, issue_number: pull_request_number, body: prComment }) } catch (error) { core.warning(`Failed to generate PR comment: ${String(error)}`) } } function renderSummaryTable(results: BuildResult[]): string { if (results.length === 0) { return 'No Gradle build results detected.' } return ` ${results.map(result => renderBuildResultRow(result)).join('')}
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build ScanĀ®
` } function renderBuildResultRow(result: BuildResult): string { return ` ${result.rootProjectName} ${result.requestedTasks} ${result.gradleVersion} ${renderOutcome(result)} ${renderBuildScan(result)} ` } function renderOutcome(result: BuildResult): string { return result.buildFailed ? ':x:' : ':white_check_mark:' } function renderBuildScan(result: BuildResult): string { if (result.buildScanFailed) { return renderBuildScanBadge( 'PUBLISH_FAILED', 'orange', 'https://docs.gradle.com/enterprise/gradle-plugin/#troubleshooting' ) } if (result.buildScanUri) { return renderBuildScanBadge('PUBLISHED', '06A0CE', result.buildScanUri) } return renderBuildScanBadge('NOT_PUBLISHED', 'lightgrey', 'https://scans.gradle.com') } function renderBuildScanBadge(outcomeText: string, outcomeColor: string, targetUrl: string): string { const badgeUrl = `https://img.shields.io/badge/Build%20Scan%C2%AE-${outcomeText}-${outcomeColor}?logo=Gradle` const badgeHtml = `Build Scan ${outcomeText}` return `${badgeHtml}` } function shouldGenerateJobSummary(): boolean { // Check if Job Summary is supported on this platform if (!process.env[SUMMARY_ENV_VAR]) { return false } return params.isJobSummaryEnabled() } function shouldAddPRComment(): boolean { return params.isPRCommentEnabled() }