Merge pull request #568 from micmarc/feature/summary-title

Feature: Add summary title
dorny · May 17, 2025 · 29aefa7 · 29aefa7
2 parents d1bf678 + f1fa471
commit 29aefa7
Showing 13 changed files with 6,997 additions and 421 deletions.
diff --git a/README.md b/README.md
@@ -154,6 +154,11 @@ jobs:
     # Allows you to generate reports for Actions Summary
     # https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/
     use-actions-summary: 'true'
+    
+    # Optionally specify a title (Heading level 1) for the report. Leading and trailing whitespace are ignored.
+    # This is useful for separating your test report from other sections in the build summary.
+    # If omitted or set to whitespace/empty, no title will be printed.
+    report-title: ''
 
     # Customize the title of badges shown for each Actions Summary.
     # Useful when distinguish summaries for tests ran in multiple Actions steps.
@@ -345,7 +350,7 @@ Support for Swift test results in xUnit format is experimental - should work but
 
 Unfortunately, there are some known issues and limitations caused by GitHub API:
 
-- Test report (i.e. Check Run summary) is markdown text. No custom styling or HTML is possible.
+- Test report (i.e. build summary) is Markdown text. No custom styling or HTML is possible.
 - Maximum report size is 65535 bytes. Input parameters `list-suites` and `list-tests` will be automatically adjusted if max size is exceeded.
 - Test report can't reference any additional files (e.g. screenshots). You can use `actions/upload-artifact@v4` to upload them and inspect them manually.
 - Check Runs are created for specific commit SHA. It's not possible to specify under which workflow test report should belong if more

diff --git a/__tests__/__outputs__/jest-test-results.md b/__tests__/__outputs__/jest-test-results.md
diff --git a/__tests__/dart-json.test.ts b/__tests__/dart-json.test.ts
@@ -3,7 +3,7 @@ import * as path from 'path'
 
 import {DartJsonParser} from '../src/parsers/dart-json/dart-json-parser'
 import {ParseOptions} from '../src/test-parser'
-import {getReport} from '../src/report/get-report'
+import {DEFAULT_OPTIONS, getReport} from '../src/report/get-report'
 import {normalizeFilePath} from '../src/utils/path-utils'
 
 describe('dart-json tests', () => {
@@ -66,4 +66,66 @@ describe('dart-json tests', () => {
     fs.mkdirSync(path.dirname(outputPath), {recursive: true})
     fs.writeFileSync(outputPath, report)
   })
+
+  it('report does not include a title by default', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dart-json.json')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DartJsonParser(opts, 'dart')
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result])
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it.each([
+    ['empty string', ''],
+    ['space', ' '],
+    ['tab', '\t'],
+    ['newline', '\n']
+  ])('report does not include a title when configured value is %s', async (_, reportTitle) => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dart-json.json')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DartJsonParser(opts, 'dart')
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle
+    })
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it('report includes a custom report title', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dart-json.json')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DartJsonParser(opts, 'dart')
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle: 'My Custom Title'
+    })
+    // Report should have the title as the first line
+    expect(report).toMatch(/^# My Custom Title\n/)
+  })
 })
diff --git a/__tests__/dotnet-nunit.test.ts b/__tests__/dotnet-nunit.test.ts
@@ -3,7 +3,7 @@ import * as path from 'path'
 
 import {DotnetNunitParser} from '../src/parsers/dotnet-nunit/dotnet-nunit-parser'
 import {ParseOptions} from '../src/test-parser'
-import {getReport} from '../src/report/get-report'
+import {DEFAULT_OPTIONS, getReport} from '../src/report/get-report'
 import {normalizeFilePath} from '../src/utils/path-utils'
 
 describe('dotnet-nunit tests', () => {
@@ -26,4 +26,66 @@ describe('dotnet-nunit tests', () => {
     fs.mkdirSync(path.dirname(outputPath), {recursive: true})
     fs.writeFileSync(outputPath, report)
   })
+
+  it('report does not include a title by default', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-nunit.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DotnetNunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result])
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it.each([
+    ['empty string', ''],
+    ['space', ' '],
+    ['tab', '\t'],
+    ['newline', '\n']
+  ])('report does not include a title when configured value is %s', async (_, reportTitle) => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-nunit.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DotnetNunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle
+    })
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it('report includes a custom report title', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-nunit.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DotnetNunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle: 'My Custom Title'
+    })
+    // Report should have the title as the first line
+    expect(report).toMatch(/^# My Custom Title\n/)
+  })
 })
diff --git a/__tests__/dotnet-trx.test.ts b/__tests__/dotnet-trx.test.ts
@@ -3,7 +3,7 @@ import * as path from 'path'
 
 import {DotnetTrxParser} from '../src/parsers/dotnet-trx/dotnet-trx-parser'
 import {ParseOptions} from '../src/test-parser'
-import {getReport} from '../src/report/get-report'
+import {DEFAULT_OPTIONS, getReport} from '../src/report/get-report'
 import {normalizeFilePath} from '../src/utils/path-utils'
 
 describe('dotnet-trx tests', () => {
@@ -99,4 +99,66 @@ describe('dotnet-trx tests', () => {
     fs.mkdirSync(path.dirname(outputPath), {recursive: true})
     fs.writeFileSync(outputPath, report)
   })
+
+  it('report does not include a title by default', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-trx.trx')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DotnetTrxParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result])
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it.each([
+    ['empty string', ''],
+    ['space', ' '],
+    ['tab', '\t'],
+    ['newline', '\n']
+  ])('report does not include a title when configured value is %s', async (_, reportTitle) => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-trx.trx')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DotnetTrxParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle
+    })
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it('report includes a custom report title', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'dotnet-trx.trx')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new DotnetTrxParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle: 'My Custom Title'
+    })
+    // Report should have the title as the first line
+    expect(report).toMatch(/^# My Custom Title\n/)
+  })
 })
diff --git a/__tests__/java-junit.test.ts b/__tests__/java-junit.test.ts
@@ -3,7 +3,7 @@ import * as path from 'path'
 
 import {JavaJunitParser} from '../src/parsers/java-junit/java-junit-parser'
 import {ParseOptions} from '../src/test-parser'
-import {getReport} from '../src/report/get-report'
+import {DEFAULT_OPTIONS, getReport} from '../src/report/get-report'
 import {normalizeFilePath} from '../src/utils/path-utils'
 
 describe('java-junit tests', () => {
@@ -90,4 +90,66 @@ describe('java-junit tests', () => {
     expect(result.result === 'failed')
     expect(result.failed === 1)
   })
+
+  it('report does not include a title by default', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'junit-with-message.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new JavaJunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result])
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it.each([
+    ['empty string', ''],
+    ['space', ' '],
+    ['tab', '\t'],
+    ['newline', '\n']
+  ])('report does not include a title when configured value is %s', async (_, reportTitle) => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'junit-with-message.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new JavaJunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle
+    })
+    // Report should have the badge as the first line
+    expect(report).toMatch(/^!\[Tests failed]/)
+  })
+
+  it('report includes a custom report title', async () => {
+    const fixturePath = path.join(__dirname, 'fixtures', 'empty', 'java-junit.xml')
+    const filePath = normalizeFilePath(path.relative(__dirname, fixturePath))
+    const fileContent = fs.readFileSync(fixturePath, {encoding: 'utf8'})
+
+    const opts: ParseOptions = {
+      parseErrors: true,
+      trackedFiles: []
+    }
+
+    const parser = new JavaJunitParser(opts)
+    const result = await parser.parse(filePath, fileContent)
+    const report = getReport([result], {
+      ...DEFAULT_OPTIONS,
+      reportTitle: 'My Custom Title'
+    })
+    // Report should have the title as the first line
+    expect(report).toMatch(/^# My Custom Title\n/)
+  })
 })