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

Commit 8902ffc

Browse files
committed
Updated CONFIGDOC.md file
1 parent 8d27967 commit 8902ffc

File tree

7 files changed

+19
-21
lines changed

7 files changed

+19
-21
lines changed

CONFIGDOC.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To configure the plugin for a freestyle project, select **Run MATLAB Tests** fro
1212

1313
![new_add_build_step](https://user-images.githubusercontent.com/47204011/55624172-be54a100-57c2-11e9-9596-52d3a60ee467.png)
1414

15-
![new_enter_matlabroot](https://user-images.githubusercontent.com/51316279/70772996-28830400-1d9c-11ea-92d1-db9f054c304c.png)
15+
![new_enter_matlabroot](https://user-images.githubusercontent.com/51316279/72131234-a5a49780-33a1-11ea-8497-45a1d9161ecf.png)
1616

1717
### Option 1: Freestyle Project with Automatic Test Mode
1818
With the Jenkins plugin for MATLAB, you have the option to run your tests in either *automatic* or *custom* mode. The automatic test mode employs a default setting to run tests written using the MATLAB Unit Testing Framework and/or Simulink Test. If your source code is organized as files and folders within a project, the plugin will consider any test files in the project that have been tagged as **Test**. If your code does not leverage a project or uses a MATLAB version prior to R2019a, the plugin will consider all tests in the current Jenkins workspace including the subfolders.
@@ -23,17 +23,17 @@ The automatic test execution feature of the plugin enables you to generate diffe
2323

2424
1) From the **Test mode** drop-down list, select the **Automatic** option (**Automatic** is the default testing mode).
2525

26-
![new_select_automatic_option](https://user-images.githubusercontent.com/51316279/70773784-6719be00-1d9e-11ea-9a6c-7b277d63e10a.png)
26+
![new_select_automatic_option](https://user-images.githubusercontent.com/51316279/72131293-cc62ce00-33a1-11ea-9573-813ac3060790.png)
2727

2828
2) Select your desired test artifacts.
2929

30-
![new_select_all_test_artifacts](https://user-images.githubusercontent.com/51316279/70773293-0dfd5a80-1d9d-11ea-8d24-28407e67c8a5.png)
30+
![new_select_all_test_artifacts](https://user-images.githubusercontent.com/51316279/72131319-e3a1bb80-33a1-11ea-99de-aef714bb5300.png)
3131

3232
The selected artifacts will be saved in the **matlabTestArtifacts** folder of the Jenkins workspace.
3333

3434
![Workspace01](https://user-images.githubusercontent.com/47204011/55470859-1e621080-5626-11e9-98f2-044144272643.JPG)
3535

36-
![Test_artifacts](https://user-images.githubusercontent.com/51316279/70776181-5bc89180-1da2-11ea-92e6-4c71deab7199.png)
36+
![Test_artifacts](https://user-images.githubusercontent.com/51316279/72140084-f625f000-33b5-11ea-8fd6-a4ebde6fcc5f.png)
3737

3838
If you do not select any of the test artifact check boxes, the **matlabTestArtifacts** folder will not be created in the workspace. However, tests will still run and potential test failures will fail the build.
3939

@@ -46,7 +46,7 @@ This option enables you to develop your custom MATLAB commands for running tests
4646

4747
1) From the **Test mode** drop-down list, select the **Custom** option.
4848

49-
![new_select_custom](https://user-images.githubusercontent.com/51316279/70775386-42731580-1da1-11ea-9523-41c83443ee5b.png)
49+
![new_select_custom](https://user-images.githubusercontent.com/51316279/72131434-31b6bf00-33a2-11ea-99da-a479dd76f826.png)
5050

5151
2) Enter your commands in the **MATLAB command** field. If you specify more than one MATLAB command, use a comma or semicolon to separate the commands. The build will fail if the execution of any command results in an error.
5252

@@ -69,11 +69,11 @@ To configure the plugin for a matrix build where tests run automatically in mult
6969

7070
1) Add a user-defined axis in the **Configuration Matrix** to represent the MATLAB versions in the build. Specify the name of the axis in the **Name** field and its values in the **Values** field. Separate the elements in the **Values** field with a space. In this example, four MATLAB versions are specified, which will be used to run the same set of tests.
7171

72-
![image](https://user-images.githubusercontent.com/47204011/62603081-c2c8cc00-b912-11e9-83a4-c5462f58f607.png)
72+
![image](https://user-images.githubusercontent.com/51316279/72132482-139e8e00-33a5-11ea-9d94-b8381c5dceca.png)
7373

7474
2) In the **Run MATLAB Tests** section of the project, include the user-defined axis name in the **MATLAB root** field to specify the locations where MATLAB is installed. In this example, **$VERSION** will be replaced by one axis value per build step.
7575

76-
![image](https://user-images.githubusercontent.com/51316279/70773424-72b8b500-1d9d-11ea-97ca-807ecd6c4e47.png)
76+
![image](https://user-images.githubusercontent.com/51316279/72131571-aee23400-33a2-11ea-8e76-4b36274b9d5b.png)
7777

7878
You can select the test artifact check boxes when tests run automatically. Once you have made your selections, save your settings and run the build.
7979

@@ -83,19 +83,19 @@ To configure the matrix build where you can customize the MATLAB test execution,
8383

8484
1) Add a user-defined axis in the **Configuration Matrix** to represent the MATLAB versions in the build.
8585

86-
![image](https://user-images.githubusercontent.com/47204011/62603081-c2c8cc00-b912-11e9-83a4-c5462f58f607.png)
86+
![image](https://user-images.githubusercontent.com/51316279/72132482-139e8e00-33a5-11ea-9d94-b8381c5dceca.png)
8787

8888
2) Add another user-defined axis using the **Add axis** button. In this example, the **TEST_TAG** axis specifies the possible test tags for a group of test elements.
8989

90-
![image](https://user-images.githubusercontent.com/47204011/62517774-b6c30880-b845-11e9-86a0-8344a281fb27.png)
90+
![image](https://user-images.githubusercontent.com/51316279/72131623-d6d19780-33a2-11ea-9205-577d6634a1a6.png)
9191

9292
3) In the **Run MATLAB Tests** section of the project, use the **VERSION** axis to specify the locations where MATLAB is installed.
9393

94-
![image](https://user-images.githubusercontent.com/51316279/70773424-72b8b500-1d9d-11ea-97ca-807ecd6c4e47.png)
94+
![image](https://user-images.githubusercontent.com/51316279/72131668-ef41b200-33a2-11ea-9f97-d9476ae0431a.png)
9595

9696
4) From the **Test mode** drop-down list, select the **Custom** option. Use the second user-defined axis to create your commands and enter them in the **MATLAB command** field. Then, save your settings and run the build.
9797

98-
![image](https://user-images.githubusercontent.com/47204011/62686681-cd529680-b9e2-11e9-82c1-c211f1740be4.png)
98+
![image](https://user-images.githubusercontent.com/51316279/72131696-04b6dc00-33a3-11ea-876f-5cdff3a027b4.png)
9999

100100
**Notes:**
101101
1) For a user-defined axis named **VAR**, **$VAR** and **${VAR}** are both valid formats for accessing the values.

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Jenkins MATLAB Plugin
22

3-
The Jenkins plugin for MATLAB® enables you to easily run your MATLAB and Simulink® tests and generate artifacts such as *PDF* test report, *JUnit* and *TAP* test results, and *Cobertura* code or model coverage reports. You can also export your Simulink Test™ Manager results. This guide shows you examples of how to configure the plugin for different objectives, considering a Microsoft® Windows® platform.
4-
5-
*Note: Producing a PDF test report is not supported on Mac OS platform.*
3+
The Jenkins plugin for MATLAB® enables you to easily run your MATLAB and Simulink® tests and generate artifacts such as *PDF* test reports, *JUnit* and *TAP* test results, and *Cobertura* code or model coverage reports. You can also export your Simulink Test™ Manager results. This guide shows you examples of how to configure the plugin for different objectives, considering a Microsoft® Windows® platform.
64

75
## Documentation
86

src/main/java/com/mathworks/ci/MatlabBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package com.mathworks.ci;
22

33
/*
4-
* Copyright 2019 The MathWorks, Inc.
4+
* Copyright 2019-2020 The MathWorks, Inc.
55
*
66
* This is Matlab Builder class which describes the build step and its components. Builder displays
77
* Build step As "Run MATLAB Tests" under Build steps. Author : Nikhil Bhoski email :

src/main/java/com/mathworks/ci/MatlabBuilderConstants.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package com.mathworks.ci;
22
/*
3-
* Copyright 2019 The MathWorks, Inc.
3+
* Copyright 2019-2020 The MathWorks, Inc.
44
*/
55

66
public class MatlabBuilderConstants {

src/main/resources/com/mathworks/ci/MatlabBuilder/RunTestsAutomaticallyOption/help-taPDFReportChkBx.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
Consider copying the report to a location outside the workspace and opening it from there. For more information,
77
see <a href="http://wiki.jenkins.io/display/JENKINS/Configuring+Content+Security+Policy">Configuring Jenkins Content Security Policy</a>.
88
<br><br>
9-
<b>Note:This feature is not supported on Mac OS platform.</b>
9+
Note:This feature is not currently supported on MacOS platforms.
1010
</div>

src/main/resources/com/mathworks/ci/MatlabBuilder/runMatlabTests.m

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
%Copyright 2019 The MathWorks, Inc.
1+
%Copyright 2019-2020 The MathWorks, Inc.
22

33
function failed = runMatlabTests(varargin)
44

@@ -111,11 +111,11 @@
111111
end
112112
end
113113

114-
% Produce PDF test report (Not supported on Mac OS platform and below R2017a)
114+
% Produce PDF test report (Not supported on MacOS platforms and below R2017a)
115115
if producePDFReport
116116
if ismac
117117
warning('MATLAB:testArtifact:unSupportedPlatform', ...
118-
'Producing a PDF test report is not supported on Mac OS platform.');
118+
'Producing a PDF test report is not currently supported on MacOS platforms.');
119119
elseif ~testReportPluginPresent
120120
issuePDFReportUnsupportedWarning;
121121
else

src/test/java/com/mathworks/ci/MatlabBuilderTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333

3434
/*
35-
* Copyright 2018-2019 The MathWorks, Inc.
35+
* Copyright 2018-2020 The MathWorks, Inc.
3636
*
3737
* Test class for MatlabBuilder
3838
*

0 commit comments

Comments
 (0)