Skip to content

feat(reporter): include config name in GitHub Actions summary header #9999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mixelburg wants to merge 2 commits into
base: main
Choose a base branch
from
+32 −4
Open

feat(reporter): include config name in GitHub Actions summary header #9999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58f7551
feat(reporter): include config name in GitHub Actions summary header
mixelburg Mar 27, 2026
93ab419
ci: trigger recheck
mixelburg Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/vitest/src/node/reporters/github-actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ export class GithubActionsReporter implements Reporter {
}

if (this.options.jobSummary.enabled === true && this.options.jobSummary.outputPath) {
const summary = renderSummary(collectSummaryData(testModules), this.options.jobSummary.fileLinks)
const summary = renderSummary(collectSummaryData(testModules), this.options.jobSummary.fileLinks, this.ctx.config.name)

try {
writeFileSync(
Expand Down Expand Up @@ -438,12 +438,13 @@ function renderStats({ fileStats, testsStats }: SummaryData): string {
return output
}

const SUMMARY_HEADER = '## Vitest Test Report\n'
const SUMMARY_HEADER = '## Vitest Test Report'

function renderSummary(summaryData: SummaryData, fileLinks?: JobSummaryOptions['fileLinks']): string {
function renderSummary(summaryData: SummaryData, fileLinks?: JobSummaryOptions['fileLinks'], configName?: string): string {
const fileLinkCreator = createGitHubFileLinkCreator(fileLinks)

let summary = `${SUMMARY_HEADER}${renderStats(summaryData)}`
const header = configName ? `${SUMMARY_HEADER} (${configName})\n` : `${SUMMARY_HEADER}\n`
let summary = `${header}${renderStats(summaryData)}`

if (summaryData.flakyTests.length > 0) {
summary += '\n### Flaky Tests\n\nThese tests passed only after one or more retries, indicating potential instability.\n'
Expand Down
27 changes: 27 additions & 0 deletions test/cli/test/reporters/github-actions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,5 +207,32 @@ describe(GithubActionsReporter, () => {
"
`)
})
it('includes config name in header when set', async ({ onTestFinished }) => {
const outputPath = resolve(tmpdir(), randomUUID())

onTestFinished(async () => {
await rm(outputPath).catch(() => {
console.error(`Could not remove ${outputPath}`)
})
})

await runVitest({
name: 'my-app',
reporters: new GithubActionsReporter({
jobSummary: {
outputPath,
fileLinks: {
commitHash: 'aaa',
repository: 'owner/repo',
},
},
}),
root: './fixtures/reporters/github-actions',
})

const summary = await readFile(outputPath, 'utf8')

expect(summary).toContain('## Vitest Test Report (my-app)')
})
})
})
Loading