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

Commit 90eb7c2

Browse files
author
Nikhil Bhoski
committed
Added help content for command & test steps.
1 parent 2f4ce43 commit 90eb7c2

File tree

7 files changed

+54
-0
lines changed

7 files changed

+54
-0
lines changed

‎src/main/resources/com/mathworks/ci/RunMatlabCommandStep/help-command.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<div>
2+
Insert the MATLAB commands you want to execute in the <b>Command</b> box. If you need to specify more than one command, use a comma or semicolon to separate the commands.<br>
3+
<b>Example: </b>results = runtests, assertSuccess(results);<br><br>
4+
If you need to specify several MATLAB commands, consider writing a MATLAB script or function and executing this script or function instead. (To run a script or function, do not specify the file extension.)<br>
5+
<b>Example: </b>myscript<br>
6+
<br>&nbsp;</br>
7+
<b>Note:</b><ul><li>The build fails if the execution of any command results in an error.</li>
8+
<li>If the build uses a MATLAB version prior to R2020a, MATLAB might display non-ASCII characters, specified in the <b>Command</b> box, as garbled text. If you specify non-ASCII characters in your commands, consider running your commands as a .m or .mlx file created in the same locale that MATLAB uses on the build agent</li>
9+
</ul>
10+
</div>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<div>
2+
<br>
3+
Generate a code coverage report in Cobertura XML format. By default, MATLAB names the artifact <b>cobertura.xml</b> and stores it in the <b>matlabTestArtifacts</b> folder of the project workspace.
4+
To override the default artifact name and location, specify a path relative to the project folder in the <b>File path</b> box. If the text box is empty, MATLAB does not generate an artifact.
5+
<br>
6+
</div>

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<div>
2+
<br>
3+
Generate a model coverage report in Cobertura XML format. This artifact includes coverage results for Simulink&#174; models that are tested using Simulink Test&#8482;.
4+
By default, MATLAB names the artifact <b>coberturamodelcoverage.xml</b> and stores it in the <b>matlabTestArtifacts</b> folder of the project workspace.
5+
<br>
6+
<br><b>Note:</b> This feature requires a <b>Simulink Coverage&#8482;</b> license and is supported only in MATLAB R2018b or a newer release.<br>
7+
<br>
8+
</div>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<div>
2+
<br>
3+
Generate a test report in JUnit XML format. By default, MATLAB names the artifact <b>junittestresults.xml</b> and stores it in the <b>matlabTestArtifacts</b> folder of the project workspace.
4+
To override the default artifact name and location, specify a path relative to the project folder in the <b>File path</b> box. If the text box is empty, MATLAB does not generate an artifact.
5+
<br>
6+
</div>

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<div>
2+
<br>
3+
Generate a test report in PDF format. By default, MATLAB names the artifact <b>testreport.pdf</b> and stores it in the <b>matlabTestArtifacts</b> folder of the project workspace.
4+
To override the default artifact name and location, specify a path relative to the project folder in the <b>File path</b> box. If the text box is empty, MATLAB does not generate an artifact.
5+
<br><br>
6+
Due to Jenkins Content Security Policy rules, the generated report might not open properly from within the Jenkins workspace.
7+
Consider copying the report to a location outside the workspace and opening it from there. For more information,
8+
see <a href="http://wiki.jenkins.io/display/JENKINS/Configuring+Content+Security+Policy">Configuring Jenkins Content Security Policy</a>.
9+
<br><br>
10+
<b>Note:</b> This feature is not currently supported on Mac platforms.
11+
</div>

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div>
2+
<br>Export Simulink Test&#8482; Manager results in MLDATX format. By default, MATLAB names the artifact <b>simulinktestresults.mldatx</b> and stores it in the <b>matlabTestArtifacts</b> folder of the project workspace.
3+
To override the default artifact name and location, specify a path relative to the project folder in the <b>File path</b> box. If the text box is empty, MATLAB does not generate an artifact.
4+
<br>
5+
<br>
6+
<b>Note:</b> This feature requires a <b>Simulink Test</b> license and is supported only in MATLAB R2019a or a newer release.
7+
</div>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<div>
2+
<br>
3+
Generate a test report in TAP format. By default, MATLAB names the artifact <b>taptestresults.tap</b> and stores it in the <b>matlabTestArtifacts</b> folder of the project workspace.
4+
To override the default artifact name and location, specify a path relative to the project folder in the <b>File path</b> box. If the text box is empty, MATLAB does not generate an artifact.
5+
<br>
6+
</div>

0 commit comments

Comments
 (0)