Skip to content

Commit 7f885a1

Browse files
authored
Merge pull request #24 from matlab-actions/remove-action-name
Remove action name from summary title.
2 parents 06fed17 + 01e4f3a commit 7f885a1

6 files changed

Lines changed: 15 additions & 26 deletions

File tree

.github/workflows/bat.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- uses: actions/checkout@v6
1818
- uses: matlab-actions/setup-matlab@v3
1919
with:
20-
release: latest-including-prerelease
20+
release: latest
2121
- uses: matlab-actions/run-tests@v3
2222
with:
2323
source-folder: plugins

src/buildSummary.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@ import * as core from "@actions/core";
33
import { join } from "path";
44
import { readFileSync, unlinkSync, existsSync } from "fs";
55

6-
export function addSummary(taskSummaryTableRows: string[][], actionName: string) {
6+
export function addSummary(taskSummaryTableRows: string[][]) {
77
try {
8-
core.summary
9-
.addHeading("MATLAB Build Results (" + actionName + ") ")
10-
.addTable(taskSummaryTableRows);
8+
core.summary.addHeading("MATLAB Build Results").addTable(taskSummaryTableRows);
119
} catch (e) {
1210
console.error("An error occurred while adding the build results table to the summary:", e);
1311
}
@@ -45,7 +43,7 @@ export function interpretSkipReason(skipReason: string) {
4543
}
4644
}
4745

48-
export function processAndAddBuildSummary(runnerTemp: string, runId: string, actionName: string) {
46+
export function processAndAddBuildSummary(runnerTemp: string, runId: string) {
4947
const header = [
5048
{ data: "MATLAB Task", header: true },
5149
{ data: "Status", header: true },
@@ -73,6 +71,6 @@ export function processAndAddBuildSummary(runnerTemp: string, runId: string, act
7371
);
7472
}
7573
}
76-
addSummary(taskSummaryTable, actionName);
74+
addSummary(taskSummaryTable);
7775
}
7876
}

src/buildSummary.unit.test.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,12 @@ describe("summaryGeneration", () => {
7878
["MATLAB Task", "Status", "Description", "Duration (HH:mm:ss)"],
7979
["Test Task", "🔴 Failed", "A test task", "00:00:10"],
8080
];
81-
const actionName = "run-build";
82-
83-
buildSummary.addSummary(mockTableRows, actionName);
81+
buildSummary.addSummary(mockTableRows);
8482

8583
expect(core.summary.addHeading).toHaveBeenCalledTimes(1);
8684
expect(core.summary.addHeading).toHaveBeenNthCalledWith(
8785
1,
88-
expect.stringContaining("MATLAB Build Results (" + actionName + ")"),
86+
expect.stringContaining("MATLAB Build Results"),
8987
);
9088
expect(core.summary.addTable).toHaveBeenCalledTimes(1);
9189
expect(core.summary.addTable).toHaveBeenCalledWith(mockTableRows);

src/testResultsSummary.ts

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,11 @@ export interface TestResultsData {
6262
Stats: TestStatistics;
6363
}
6464

65-
export function processAndAddTestSummary(
66-
runnerTemp: string,
67-
runId: string,
68-
actionName: string,
69-
workspace: string,
70-
) {
65+
export function processAndAddTestSummary(runnerTemp: string, runId: string, workspace: string) {
7166
const testResultsData = getTestResults(runnerTemp, runId, workspace);
7267
const coverageResultsData = getCoverageResults(runnerTemp, runId);
7368
if (testResultsData || coverageResultsData) {
74-
addSummary(testResultsData, coverageResultsData, actionName);
69+
addSummary(testResultsData, coverageResultsData);
7570
}
7671
}
7772

@@ -137,7 +132,6 @@ export function getTestResults(
137132
export function addSummary(
138133
testResultsData: TestResultsData | null,
139134
coverageResultsData: CoverageData | null,
140-
actionName: string,
141135
) {
142136
try {
143137
// Add test results table if available
@@ -147,9 +141,7 @@ export function addSummary(
147141
` target="_blank" title="View documentation">ℹ️</a>`;
148142
const header = getTestHeader(testResultsData.Stats);
149143

150-
core.summary
151-
.addHeading("MATLAB Test Results (" + actionName + ") " + helpLink)
152-
.addRaw(header, true);
144+
core.summary.addHeading("MATLAB Test Results " + helpLink).addRaw(header, true);
153145
}
154146
// Add coverage table if available
155147
if (coverageResultsData) {

src/testResultsSummary.unit.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,12 @@ describe("Artifact Processing Tests", () => {
151151
it("should write test results data to the GitHub job summary", () => {
152152
if (testResultsData) {
153153
const actionName = process.env.GITHUB_ACTION || "";
154-
testResultsSummary.addSummary(testResultsData, null, actionName);
154+
testResultsSummary.addSummary(testResultsData, null);
155155

156156
expect(core.summary.addHeading).toHaveBeenCalledTimes(2);
157157
expect(core.summary.addHeading).toHaveBeenNthCalledWith(
158158
1,
159-
expect.stringContaining("MATLAB Test Results (" + actionName + ")"),
159+
expect.stringContaining("MATLAB Test Results "),
160160
);
161161
expect(core.summary.addHeading).toHaveBeenNthCalledWith(
162162
1,
@@ -355,7 +355,7 @@ describe("Error Handling Tests", () => {
355355

356356
// This should not throw, but should log the error
357357
expect(() => {
358-
testResultsSummary.addSummary(mockTestResultsData, null, "mockAction");
358+
testResultsSummary.addSummary(mockTestResultsData, null);
359359
}).not.toThrow();
360360

361361
// Verify error was logged

tests/tParallelizableBuildSummaryPlugin.m

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
function setupPath(testCase)
1313
import matlab.unittest.fixtures.PathFixture;
1414

15+
testCase.assumeFalse(isMATLABReleaseOlderThan("R2026a"));
1516
testCase.applyFixture(PathFixture(fileparts(fileparts(mfilename("fullpath")))));
1617
end
1718
end
@@ -107,4 +108,4 @@ function runningBuildCreatesSummaryForTaskGroups(testCase)
107108

108109
function task = Task(varargin)
109110
task = matlab.buildtool.Task(varargin{:});
110-
end
111+
end

0 commit comments

Comments
 (0)