From 828632acd025c710d46b2c60ade6b5257ea06caf Mon Sep 17 00:00:00 2001 From: pespinel Date: Mon, 20 Oct 2025 14:52:37 +0200 Subject: [PATCH] feat: add collapsed option to control report visibility --- action.yml | 8 ++++++++ dist/index.js | 19 +++++++++++++------ src/main.ts | 9 ++++++--- src/report/get-report.ts | 14 +++++++++++--- 4 files changed, 38 insertions(+), 12 deletions(-) diff --git a/action.yml b/action.yml index 7777d56..c8dd56b 100644 --- a/action.yml +++ b/action.yml @@ -89,6 +89,14 @@ inputs: description: Customize badge title required: false default: 'tests' + collapsed: + description: | + Controls whether test report details are collapsed or expanded. Supported options: + - auto: Collapse only if all tests pass (default behavior) + - always: Always collapse the report details + - never: Always expand the report details + required: false + default: 'auto' token: description: GitHub Access Token required: false diff --git a/dist/index.js b/dist/index.js index d5914fe..7a5188d 100644 --- a/dist/index.js +++ b/dist/index.js @@ -309,6 +309,7 @@ class TestReporter { useActionsSummary = core.getInput('use-actions-summary', { required: false }) === 'true'; badgeTitle = core.getInput('badge-title', { required: false }); reportTitle = core.getInput('report-title', { required: false }); + collapsed = core.getInput('collapsed', { required: false }); token = core.getInput('token', { required: true }); octokit; context = (0, github_utils_1.getCheckRunContext)(); @@ -401,7 +402,7 @@ class TestReporter { throw error; } } - const { listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle } = this; + const { listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle, collapsed } = this; const passed = results.reduce((sum, tr) => sum + tr.passed, 0); const failed = results.reduce((sum, tr) => sum + tr.failed, 0); const skipped = results.reduce((sum, tr) => sum + tr.skipped, 0); @@ -415,7 +416,8 @@ class TestReporter { onlySummary, useActionsSummary, badgeTitle, - reportTitle + reportTitle, + collapsed }); core.info('Summary content:'); core.info(summary); @@ -443,7 +445,8 @@ class TestReporter { onlySummary, useActionsSummary, badgeTitle, - reportTitle + reportTitle, + collapsed }); core.info('Creating annotations'); const annotations = (0, get_annotations_1.getAnnotations)(results, this.maxAnnotations); @@ -1924,7 +1927,8 @@ exports.DEFAULT_OPTIONS = { onlySummary: false, useActionsSummary: true, badgeTitle: 'tests', - reportTitle: '' + reportTitle: '', + collapsed: 'auto' }; function getReport(results, options = exports.DEFAULT_OPTIONS) { core.info('Generating check run summary'); @@ -2031,7 +2035,10 @@ function getBadge(passed, failed, skipped, options) { function getTestRunsReport(testRuns, options) { const sections = []; const totalFailed = testRuns.reduce((sum, tr) => sum + tr.failed, 0); - if (totalFailed === 0) { + // Determine if report should be collapsed based on collapsed option + const shouldCollapse = options.collapsed === 'always' || + (options.collapsed === 'auto' && totalFailed === 0); + if (shouldCollapse) { sections.push(`
Expand for details`); sections.push(` `); } @@ -2056,7 +2063,7 @@ function getTestRunsReport(testRuns, options) { const suitesReports = testRuns.map((tr, i) => getSuitesReport(tr, i, options)).flat(); sections.push(...suitesReports); } - if (totalFailed === 0) { + if (shouldCollapse) { sections.push(`
`); } return sections; diff --git a/src/main.ts b/src/main.ts index 57137ab..1dccea7 100644 --- a/src/main.ts +++ b/src/main.ts @@ -49,6 +49,7 @@ class TestReporter { readonly useActionsSummary = core.getInput('use-actions-summary', {required: false}) === 'true' readonly badgeTitle = core.getInput('badge-title', {required: false}) readonly reportTitle = core.getInput('report-title', {required: false}) + readonly collapsed = core.getInput('collapsed', {required: false}) as 'auto' | 'always' | 'never' readonly token = core.getInput('token', {required: true}) readonly octokit: InstanceType readonly context = getCheckRunContext() @@ -166,7 +167,7 @@ class TestReporter { } } - const {listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle} = this + const {listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle, collapsed} = this const passed = results.reduce((sum, tr) => sum + tr.passed, 0) const failed = results.reduce((sum, tr) => sum + tr.failed, 0) @@ -182,7 +183,8 @@ class TestReporter { onlySummary, useActionsSummary, badgeTitle, - reportTitle + reportTitle, + collapsed }) core.info('Summary content:') @@ -211,7 +213,8 @@ class TestReporter { onlySummary, useActionsSummary, badgeTitle, - reportTitle + reportTitle, + collapsed }) core.info('Creating annotations') diff --git a/src/report/get-report.ts b/src/report/get-report.ts index 5168b7a..08bea71 100644 --- a/src/report/get-report.ts +++ b/src/report/get-report.ts @@ -16,6 +16,7 @@ export interface ReportOptions { useActionsSummary: boolean badgeTitle: string reportTitle: string + collapsed: 'auto' | 'always' | 'never' } export const DEFAULT_OPTIONS: ReportOptions = { @@ -25,7 +26,8 @@ export const DEFAULT_OPTIONS: ReportOptions = { onlySummary: false, useActionsSummary: true, badgeTitle: 'tests', - reportTitle: '' + reportTitle: '', + collapsed: 'auto' } export function getReport(results: TestRunResult[], options: ReportOptions = DEFAULT_OPTIONS): string { @@ -154,7 +156,13 @@ export function getBadge(passed: number, failed: number, skipped: number, option function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): string[] { const sections: string[] = [] const totalFailed = testRuns.reduce((sum, tr) => sum + tr.failed, 0) - if (totalFailed === 0) { + + // Determine if report should be collapsed based on collapsed option + const shouldCollapse = + options.collapsed === 'always' || + (options.collapsed === 'auto' && totalFailed === 0) + + if (shouldCollapse) { sections.push(`
Expand for details`) sections.push(` `) } @@ -187,7 +195,7 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s sections.push(...suitesReports) } - if (totalFailed === 0) { + if (shouldCollapse) { sections.push(`
`) } return sections