Add generate-job-summary input to control CI job summary generation (#93)

* add opt-out field

* make prettier

* update input and add test

* add actionName to file name

* make prettier

* update common-utils version and yml file

* update field name to generate-summary

* update field description

* remove continue-on-error

* update variable name

Author: mw-kapilg

.github/workflows/bat.yml

@@ -40,8 +40,12 @@ jobs:
             Simulink
             Simulink_Test
             Simulink_Coverage
+      - name: Run MATLAB Tests with job summary disabled
+        uses: ./
+        with:
+          source-folder: sample
+          generate-summary: false
       - name: Run MATLAB Tests
-        continue-on-error: true
         uses: ./
         with:
           source-folder: sample
@@ -65,7 +69,6 @@ jobs:
       - name: Set up diary for logging
         run: echo 'diary console.log' >> startup.m
       - name: Run run-test command
-        continue-on-error: true
         uses: ./
         with:
           test-results-simulink-test: test-results/simulinktest.mldatx

.gitignore

@@ -1,6 +1,9 @@
 ## For development environment
 .vscode
 
+# Claude
+.claude/
+
 # Don't include intermediate TypeScript compilation;
 # it should be forcibly added on release
 lib

action.yml

@@ -84,6 +84,11 @@ inputs:
       Startup options for MATLAB
     required: false
     default: ""
+  generate-summary:
+    description: >-
+      Option to generate a summary for the GitHub job summary
+    required: false
+    default: true
   code-coverage-metric-level:
     description: >-
       Level of coverage metrics to collect

package-lock.json

@@ -22,7 +22,7 @@
     "dependencies": {
         "@actions/core": "^3.0.0",
         "@actions/exec": "^3.0.0",
-        "common-utils": "github:matlab-actions/common-utils#v2.2.2"
+        "common-utils": "github:matlab-actions/common-utils#v2.3.1"
     },
     "devDependencies": {
         "@types/jest": "^30.0.0",

package.json

@@ -7,14 +7,14 @@
             productNames = string({verInfo.Name});
             productName = 'MATLAB Test';
             isProductInstalled = any(productNames.matches(productName));
-            hasCoverageHTML = ~isempty(getenv('INPUT_CODE_COVERAGE_HTML'));
-            hasCoverageCobertura = ~isempty(getenv('INPUT_CODE_COVERAGE_COBERTURA'));
+            hasCoverageHTML = ~isempty(getenv('MW_INPUT_CODE_COVERAGE_HTML'));
+            hasCoverageCobertura = ~isempty(getenv('MW_INPUT_CODE_COVERAGE_COBERTURA'));
             hasCoverageRequest = hasCoverageHTML || hasCoverageCobertura;
 
             % Check if MATLAB Test license is available and MATLAB Test is installed
-            if license('test', 'matlab_test') && isProductInstalled && ~hasCoverageRequest
+            if strcmpi(getenv("MW_INPUT_GENERATE_SUMMARY"), "true") && ~hasCoverageRequest && license('test', 'matlab_test') && isProductInstalled
                 % Get metric level from environment variable
-                metricLevel = getenv('INPUT_CODE_COVERAGE_METRIC_LEVEL');
+                metricLevel = getenv('MW_INPUT_CODE_COVERAGE_METRIC_LEVEL');
 
                 % Create a shared CoverageResult format object
                 format = matlab.unittest.plugins.codecoverage.CoverageResult;
@@ -23,7 +23,7 @@
                 plugins = matlab.unittest.plugins.TestRunnerPlugin.empty(0);
 
                 % Get source folder from environment variable
-                sourceFolder = getenv('INPUT_SOURCE_FOLDER');
+                sourceFolder = getenv('MW_INPUT_SOURCE_FOLDER');
                 if isempty(sourceFolder)
                     sourceFolder = pwd;
                 end

plugins/+matlab/+unittest/+internal/+services/+plugins/CodeCoverageSummaryPluginService.m

@@ -31,6 +31,7 @@ async function run() {
         LoggingLevel: core.getInput("logging-level"),
     };
 
+    const generateSummary = core.getBooleanInput("generate-summary");
     var codeCoverageMetricLevel = core.getInput("code-coverage-metric-level").toLowerCase();
 
     // Validate metric level
@@ -50,10 +51,11 @@ async function run() {
         env: {
             ...process.env,
             MW_BATCH_LICENSING_ONLINE: "true", // Remove when online batch licensing is the default
-            INPUT_CODE_COVERAGE_METRIC_LEVEL: codeCoverageMetricLevel,
-            INPUT_SOURCE_FOLDER: options.SourceFolder!, // Add source folder to environment
-            INPUT_CODE_COVERAGE_HTML: options.HTMLCodeCoverage!,
-            INPUT_CODE_COVERAGE_COBERTURA: options.CoberturaCodeCoverage!,
+            MW_INPUT_CODE_COVERAGE_METRIC_LEVEL: codeCoverageMetricLevel,
+            MW_INPUT_SOURCE_FOLDER: options.SourceFolder!, // Add source folder to environment
+            MW_INPUT_CODE_COVERAGE_HTML: options.HTMLCodeCoverage!,
+            MW_INPUT_CODE_COVERAGE_COBERTURA: options.CoberturaCodeCoverage!,
+            MW_INPUT_GENERATE_SUMMARY: String(generateSummary),
         },
     };
     core.info("Successfully generated test script!");
@@ -67,12 +69,19 @@ async function run() {
             startupOptions,
         )
         .finally(() => {
-            const runnerTemp = process.env.RUNNER_TEMP || "";
-            const runId = process.env.GITHUB_RUN_ID || "";
+            if (generateSummary) {
+                const runnerTemp = process.env.RUNNER_TEMP || "";
+                const runId = process.env.GITHUB_RUN_ID || "";
+                const actionName = process.env.GITHUB_ACTION || "";
 
-            //add test results and code coverage view
-            testResultsSummary.processAndAddTestSummary(runnerTemp, runId, workspaceDir);
-            core.summary.write();
+                testResultsSummary.processAndAddTestSummary(
+                    runnerTemp,
+                    runId,
+                    actionName,
+                    workspaceDir,
+                );
+                core.summary.write();
+            }
         });
 }