Skip to content
This repository was archived by the owner on Mar 27, 2025. It is now read-only.

Commit bac7ca5

Browse files
authored
Merge pull request #213 from mathworks/dev_main
This PR contains doc and help text changes for PDF test report generation support in Mac OS
2 parents bcd7b37 + 6240610 commit bac7ca5

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

CONFIGDOC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Select check boxes in the **Generate Test Artifacts** and **Generate Coverage Ar
8585
The **Run MATLAB Tests** build step produces a MATLAB script file and uses it to run the tests and generate the artifacts. The plugin writes the contents of this file to the build log. You can review the build log in **Console Output** to understand the testing workflow.
8686

8787
Artifacts to generate with the plugin are subject to these restrictions:
88-
* Producing a PDF test report is not currently supported on macOS platforms.
88+
* Producing a PDF test report on macOS platforms is supported in MATLAB R2020b and later.
8989
* Exporting Simulink Test™ Manager results requires a Simulink Test license and is supported in MATLAB R2019a and later.
9090
* Producing a Cobertura model coverage report requires a Simulink Coverage™ license and is supported in MATLAB R2018b and later.
9191

@@ -273,7 +273,7 @@ Input | Description
273273
`sourceFolder` | (Optional) Location of the folder containing source code, relative to the project root folder. The specified folder and its subfolders are added to the top of the MATLAB search path. If you specify `sourceFolder` and then generate a coverage report, the plugin uses only the source code in the specified folder and its subfolders to generate the report.<br/>**Example:** `['source']`<br/>**Example:** `['source/folderA', 'source/folderB']`
274274
`selectByFolder` | (Optional) Location of the folder used to select test suite elements, relative to the project root folder. To create a test suite, the plugin uses only the tests in the specified folder and its subfolders.<br/>**Example:** `['test']`<br/>**Example:** `['test/folderA', 'test/folderB']`
275275
`selectByTag` | (Optional) Test tag used to select test suite elements. To create a test suite, the plugin uses only the test elements with the specified tag.<br/>**Example:** `'FeatureA'`
276-
`testResultsPDF` | (Optional) Path to write test results report in PDF format. Currently, this input is not supported on macOS platforms.<br/>**Example:** `'test-results/results.pdf'`
276+
`testResultsPDF` | (Optional) Path to write test results report in PDF format. On macOS platforms, this input is supported in MATLAB R2020b and later.<br/>**Example:** `'test-results/results.pdf'`
277277
`testResultsTAP` | (Optional) Path to write test results report in TAP format.<br/>**Example:** `'test-results/results.tap'`
278278
`testResultsJUnit` | (Optional) Path to write test results report in JUnit XML format.<br/>**Example:** `'test-results/results.xml'`
279279
`testResultsSimulinkTest` | (Optional) Path to export Simulink Test Manager results in MLDATX format. This input requires a Simulink Test license and is supported in MATLAB R2019a and later.<br/>**Example:** `'test-results/results.mldatx'`

src/main/resources/com/mathworks/ci/RunMatlabTestsBuilder/help-pdfReportArtifact.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@
77
Consider copying the report to a location outside the workspace and opening it from there. For more information,
88
see <a href="http://wiki.jenkins.io/display/JENKINS/Configuring+Content+Security+Policy">Configuring Jenkins Content Security Policy</a>.
99
<br><br>
10-
<b>Note:</b> This feature is not currently supported on Mac platforms.
10+
<b>Note:</b> On macOS platforms, this feature is supported in MATLAB R2020b and later.
11+
1112
</div>

src/main/resources/com/mathworks/ci/RunMatlabTestsStep/help-testResultsPDF.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@
77
Consider copying the report to a location outside the workspace and opening it from there. For more information,
88
see <a href="http://wiki.jenkins.io/display/JENKINS/Configuring+Content+Security+Policy">Configuring Jenkins Content Security Policy</a>.
99
<br><br>
10-
<b>Note:</b> This feature is not currently supported on Mac platforms.
10+
<b>Note:</b> On macOS platforms, this feature is supported in MATLAB R2020b and later.
11+
1112
</div>

0 commit comments

Comments
 (0)