Import the GitHub type from @actions/github with file extension syntax

This improves the code compatibility with the ESM syntax. Issue #603
Merge pull request #588 from OlesGalatsan/features/add-links-to-report
2026-02-02 03:15:22 -08:00 · 2025-06-08 13:25:17 +02:00 · 2025-06-08 13:13:59 +02:00 · 2025-06-08 13:09:53 +02:00 · 2025-06-08 13:09:27 +02:00 · 2025-06-08 12:59:33 +02:00
24 changed files with 45 additions and 36 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -10,6 +10,7 @@
  "rules": {
    "i18n-text/no-en": "off",
    "eslint-comments/no-use": "off",
+    "import/extensions": [ "error", "ignorePackages", { "ts": "never" } ],
    "import/no-namespace": "off",
    "import/no-named-as-default": "off",
    "no-shadow": "off",
--- a/tests/outputs/dart-json.md
+++ b/tests/outputs/dart-json.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-1%20passed%2C%204%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/dart-json.json|1 ✅|4 ❌|1 ⚪|4s|
+|[fixtures/dart-json.json](#user-content-r0)|1 ✅|4 ❌|1 ⚪|4s|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/dart-json.json</a>
 **6** tests were completed in **4s** with **1** passed, **4** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/dotnet-nunit.md
+++ b/tests/outputs/dotnet-nunit.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-3%20passed%2C%205%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/dotnet-nunit.xml|3 ✅|5 ❌|1 ⚪|230ms|
+|[fixtures/dotnet-nunit.xml](#user-content-r0)|3 ✅|5 ❌|1 ⚪|230ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/dotnet-nunit.xml</a>
 **9** tests were completed in **230ms** with **3** passed, **5** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/dotnet-trx.md
+++ b/tests/outputs/dotnet-trx.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-5%20passed%2C%205%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/dotnet-trx.trx|5 ✅|5 ❌|1 ⚪|1s|
+|[fixtures/dotnet-trx.trx](#user-content-r0)|5 ✅|5 ❌|1 ⚪|1s|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/dotnet-trx.trx</a>
 **11** tests were completed in **1s** with **5** passed, **5** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/fluent-validation-test-results.md
+++ b/tests/outputs/fluent-validation-test-results.md
@@ -3,7 +3,7 @@
 
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/FluentValidation.Tests.trx|803 ✅||1 ⚪|4s|
+|[fixtures/external/FluentValidation.Tests.trx](#user-content-r0)|803 ✅||1 ⚪|4s|
 ## ✅ <a id="user-content-r0" href="#user-content-r0">fixtures/external/FluentValidation.Tests.trx</a>
 **804** tests were completed in **4s** with **803** passed, **0** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/golang-json.md
+++ b/tests/outputs/golang-json.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-5%20passed%2C%206%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/golang-json.json|5 ✅|6 ❌|1 ⚪|6s|
+|[fixtures/golang-json.json](#user-content-r0)|5 ✅|6 ❌|1 ⚪|6s|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/golang-json.json</a>
 **12** tests were completed in **6s** with **5** passed, **6** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/jest-junit-eslint.md
+++ b/tests/outputs/jest-junit-eslint.md
@@ -3,7 +3,7 @@
 
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/jest-junit-eslint.xml|1 ✅|||0ms|
+|[fixtures/jest-junit-eslint.xml](#user-content-r0)|1 ✅|||0ms|
 ## ✅ <a id="user-content-r0" href="#user-content-r0">fixtures/jest-junit-eslint.xml</a>
 **1** tests were completed in **0ms** with **1** passed, **0** failed and **0** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/jest-junit.md
+++ b/tests/outputs/jest-junit.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-1%20passed%2C%204%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/jest-junit.xml|1 ✅|4 ❌|1 ⚪|1s|
+|[fixtures/jest-junit.xml](#user-content-r0)|1 ✅|4 ❌|1 ⚪|1s|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/jest-junit.xml</a>
 **6** tests were completed in **1s** with **1** passed, **4** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/jest-react-component-test-results.md
+++ b/tests/outputs/jest-react-component-test-results.md
@@ -3,7 +3,7 @@
 
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/jest/jest-react-component-test-results.xml|1 ✅|||1000ms|
+|[fixtures/external/jest/jest-react-component-test-results.xml](#user-content-r0)|1 ✅|||1000ms|
 ## ✅ <a id="user-content-r0" href="#user-content-r0">fixtures/external/jest/jest-react-component-test-results.xml</a>
 **1** tests were completed in **1000ms** with **1** passed, **0** failed and **0** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/jest-test-results.md
+++ b/tests/outputs/jest-test-results.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-4207%20passed%2C%202%20failed%2C%2030%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/jest/jest-test-results.xml|4207 ✅|2 ❌|30 ⚪|166s|
+|[fixtures/external/jest/jest-test-results.xml](#user-content-r0)|4207 ✅|2 ❌|30 ⚪|166s|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/external/jest/jest-test-results.xml</a>
 **4239** tests were completed in **166s** with **4207** passed, **2** failed and **30** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/junit-with-message.md
+++ b/tests/outputs/junit-with-message.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-1%20failed-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/junit-with-message.xml||1 ❌||1ms|
+|[fixtures/junit-with-message.xml](#user-content-r0)||1 ❌||1ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/junit-with-message.xml</a>
 **1** tests were completed in **1ms** with **0** passed, **1** failed and **0** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/mocha-json.md
+++ b/tests/outputs/mocha-json.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-1%20passed%2C%204%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/mocha-json.json|1 ✅|4 ❌|1 ⚪|12ms|
+|[fixtures/mocha-json.json](#user-content-r0)|1 ✅|4 ❌|1 ⚪|12ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/mocha-json.json</a>
 **6** tests were completed in **12ms** with **1** passed, **4** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/mocha-test-results.md
+++ b/tests/outputs/mocha-test-results.md
@@ -3,7 +3,7 @@
 
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/mocha/mocha-test-results.json|833 ✅||6 ⚪|6s|
+|[fixtures/external/mocha/mocha-test-results.json](#user-content-r0)|833 ✅||6 ⚪|6s|
 ## ✅ <a id="user-content-r0" href="#user-content-r0">fixtures/external/mocha/mocha-test-results.json</a>
 **839** tests were completed in **6s** with **833** passed, **0** failed and **6** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/provider-test-results.md
+++ b/tests/outputs/provider-test-results.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-268%20passed%2C%201%20failed-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/flutter/provider-test-results.json|268 ✅|1 ❌||0ms|
+|[fixtures/external/flutter/provider-test-results.json](#user-content-r0)|268 ✅|1 ❌||0ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/external/flutter/provider-test-results.json</a>
 **269** tests were completed in **0ms** with **268** passed, **1** failed and **0** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/pulsar-test-results-no-merge.md
+++ b/tests/outputs/pulsar-test-results-no-merge.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-1%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/java/TEST-org.apache.pulsar.AddMissingPatchVersionTest.xml||1 ❌|1 ⚪|116ms|
+|[fixtures/external/java/TEST-org.apache.pulsar.AddMissingPatchVersionTest.xml](#user-content-r0)||1 ❌|1 ⚪|116ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/external/java/TEST-org.apache.pulsar.AddMissingPatchVersionTest.xml</a>
 **2** tests were completed in **116ms** with **0** passed, **1** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/pulsar-test-results.md
+++ b/tests/outputs/pulsar-test-results.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-793%20passed%2C%201%20failed%2C%2014%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/java/pulsar-test-report.xml|793 ✅|1 ❌|14 ⚪|2127s|
+|[fixtures/external/java/pulsar-test-report.xml](#user-content-r0)|793 ✅|1 ❌|14 ⚪|2127s|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/external/java/pulsar-test-report.xml</a>
 **808** tests were completed in **2127s** with **793** passed, **1** failed and **14** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/rspec-json.md
+++ b/tests/outputs/rspec-json.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-1%20passed%2C%201%20failed%2C%201%20skipped-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/rspec-json.json|1 ✅|1 ❌|1 ⚪|0ms|
+|[fixtures/rspec-json.json](#user-content-r0)|1 ✅|1 ❌|1 ⚪|0ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/rspec-json.json</a>
 **3** tests were completed in **0ms** with **1** passed, **1** failed and **1** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/silent-notes-test-results.md
+++ b/tests/outputs/silent-notes-test-results.md
@@ -3,7 +3,7 @@
 
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/external/SilentNotes.trx|67 ✅||12 ⚪|1s|
+|[fixtures/external/SilentNotes.trx](#user-content-r0)|67 ✅||12 ⚪|1s|
 ## ✅ <a id="user-content-r0" href="#user-content-r0">fixtures/external/SilentNotes.trx</a>
 **79** tests were completed in **1s** with **67** passed, **0** failed and **12** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/tests/outputs/swift-xunit.md
+++ b/tests/outputs/swift-xunit.md
@@ -1,7 +1,7 @@
 ![Tests failed](https://img.shields.io/badge/tests-2%20passed%2C%201%20failed-critical)
 |Report|Passed|Failed|Skipped|Time|
 |:---|---:|---:|---:|---:|
-|fixtures/swift-xunit.xml|2 ✅|1 ❌||220ms|
+|[fixtures/swift-xunit.xml](#user-content-r0)|2 ✅|1 ❌||220ms|
 ## ❌ <a id="user-content-r0" href="#user-content-r0">fixtures/swift-xunit.xml</a>
 **3** tests were completed in **220ms** with **2** passed, **1** failed and **0** skipped.
 |Test suite|Passed|Failed|Skipped|Time|
--- a/dist/index.js
+++ b/dist/index.js
@@ -402,6 +402,10 @@ class TestReporter {
            }
        }
        const { listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle } = 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);
+        const shortSummary = `${passed} passed, ${failed} failed and ${skipped} skipped `;
        let baseUrl = '';
        if (this.useActionsSummary) {
            const summary = (0, get_report_1.getReport)(results, {
@@ -415,6 +419,7 @@ class TestReporter {
            });
            core.info('Summary content:');
            core.info(summary);
+            core.summary.addRaw(`# ${shortSummary}`);
            await core.summary.addRaw(summary).write();
        }
        else {
@@ -444,10 +449,6 @@ class TestReporter {
            const annotations = (0, get_annotations_1.getAnnotations)(results, this.maxAnnotations);
            const isFailed = this.failOnError && results.some(tr => tr.result === 'failed');
            const conclusion = isFailed ? 'failure' : 'success';
-            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);
-            const shortSummary = `${passed} passed, ${failed} failed and ${skipped} skipped `;
            core.info(`Updating check run conclusion (${conclusion}) and output`);
            const resp = await this.octokit.rest.checks.update({
                check_run_id: createResp.data.id,
@@ -2033,14 +2034,17 @@ function getTestRunsReport(testRuns, options) {
    }
    if (testRuns.length > 0 || options.onlySummary) {
        const tableData = testRuns
-            .filter(tr => tr.passed > 0 || tr.failed > 0 || tr.skipped > 0)
-            .map(tr => {
+            .map((tr, originalIndex) => ({ tr, originalIndex }))
+            .filter(({ tr }) => tr.passed > 0 || tr.failed > 0 || tr.skipped > 0)
+            .map(({ tr, originalIndex }) => {
            const time = (0, markdown_utils_1.formatTime)(tr.time);
            const name = tr.path;
+            const addr = options.baseUrl + makeRunSlug(originalIndex, options).link;
+            const nameLink = (0, markdown_utils_1.link)(name, addr);
            const passed = tr.passed > 0 ? `${tr.passed} ${markdown_utils_1.Icon.success}` : '';
            const failed = tr.failed > 0 ? `${tr.failed} ${markdown_utils_1.Icon.fail}` : '';
            const skipped = tr.skipped > 0 ? `${tr.skipped} ${markdown_utils_1.Icon.skip}` : '';
-            return [name, passed, failed, skipped, time];
+            return [nameLink, passed, failed, skipped, time];
        });
        const resultsTable = (0, markdown_utils_1.table)(['Report', 'Passed', 'Failed', 'Skipped', 'Time'], [markdown_utils_1.Align.Left, markdown_utils_1.Align.Right, markdown_utils_1.Align.Right, markdown_utils_1.Align.Right, markdown_utils_1.Align.Right], ...tableData);
        sections.push(resultsTable);
--- a/src/input-providers/artifact-provider.ts
+++ b/src/input-providers/artifact-provider.ts
@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {GitHub} from '@actions/github/lib/utils'
+import type {GitHub} from '@actions/github/lib/utils.js'

 import Zip from 'adm-zip'
 import picomatch from 'picomatch'
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {GitHub} from '@actions/github/lib/utils'
+import type {GitHub} from '@actions/github/lib/utils.js'

 import {ArtifactProvider} from './input-providers/artifact-provider'
 import {LocalFileProvider} from './input-providers/local-file-provider'
@@ -168,6 +168,11 @@ class TestReporter {

    const {listSuites, listTests, onlySummary, useActionsSummary, badgeTitle, reportTitle} = 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)
+    const shortSummary = `${passed} passed, ${failed} failed and ${skipped} skipped `
+
    let baseUrl = ''
    if (this.useActionsSummary) {
      const summary = getReport(results, {
@@ -182,6 +187,7 @@ class TestReporter {

      core.info('Summary content:')
      core.info(summary)
+      core.summary.addRaw(`# ${shortSummary}`)
      await core.summary.addRaw(summary).write()
    } else {
      core.info(`Creating check run ${name}`)
@@ -214,11 +220,6 @@ class TestReporter {
      const isFailed = this.failOnError && results.some(tr => tr.result === 'failed')
      const conclusion = isFailed ? 'failure' : 'success'

-      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)
-      const shortSummary = `${passed} passed, ${failed} failed and ${skipped} skipped `
-
      core.info(`Updating check run conclusion (${conclusion}) and output`)
      const resp = await this.octokit.rest.checks.update({
        check_run_id: createResp.data.id,
--- a/src/report/get-report.ts
+++ b/src/report/get-report.ts
@@ -159,14 +159,17 @@ function getTestRunsReport(testRuns: TestRunResult[], options: ReportOptions): s

  if (testRuns.length > 0 || options.onlySummary) {
    const tableData = testRuns
-      .filter(tr => tr.passed > 0 || tr.failed > 0 || tr.skipped > 0)
-      .map(tr => {
+      .map((tr, originalIndex) => ({tr, originalIndex}))
+      .filter(({tr}) => tr.passed > 0 || tr.failed > 0 || tr.skipped > 0)
+      .map(({tr, originalIndex}) => {
        const time = formatTime(tr.time)
        const name = tr.path
+        const addr = options.baseUrl + makeRunSlug(originalIndex, options).link
+        const nameLink = link(name, addr)
        const passed = tr.passed > 0 ? `${tr.passed} ${Icon.success}` : ''
        const failed = tr.failed > 0 ? `${tr.failed} ${Icon.fail}` : ''
        const skipped = tr.skipped > 0 ? `${tr.skipped} ${Icon.skip}` : ''
-        return [name, passed, failed, skipped, time]
+        return [nameLink, passed, failed, skipped, time]
      })

    const resultsTable = table(
--- a/src/utils/github-utils.ts
+++ b/src/utils/github-utils.ts
@@ -1,7 +1,7 @@
 import {createWriteStream} from 'fs'
 import * as core from '@actions/core'
 import * as github from '@actions/github'
-import {GitHub} from '@actions/github/lib/utils'
+import type {GitHub} from '@actions/github/lib/utils.js'
 import type {PullRequest} from '@octokit/webhooks-types'
 import * as stream from 'stream'
 import {promisify} from 'util'
Author	SHA1	Message	Date
Jozef Izso	67059baf3b	Import the `GitHub` type from `@actions/github` with file extension syntax This improves the code compatibility with the ESM syntax. Issue #603	2025-06-08 13:25:17 +02:00
Jozef Izso	a6b3e93884	Merge pull request #588 from OlesGalatsan/features/add-links-to-report	2025-06-08 13:13:59 +02:00
Jozef Izso	223c6cd55b	Compile dist code	2025-06-08 13:09:53 +02:00
Oles Galatsan	b522d19cac	Return links to summary report	2025-06-08 13:09:27 +02:00
Jozef Izso	d56352b96c	Merge pull request #589 from OlesGalatsan/features/add-step-summary-short-summary	2025-06-08 12:59:33 +02:00
Oles Galatsan	9934a5fbd4	Merge branch 'features/add-step-summary-short-summary' of github.com:OlesGalatsan/test-reporter into features/add-step-summary-short-summary	2025-05-20 14:46:19 +03:00
Oles Galatsan	0f25185fa5	Rebuild	2025-05-20 14:46:05 +03:00
Oles Galatsan	fb07f1b2a5	Merge branch 'dorny:main' into features/add-step-summary-short-summary	2025-05-20 14:25:01 +03:00
Oles Galatsan	364887ed35	Add short summary for step summary	2025-05-20 12:11:51 +03:00