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

Commit b76d7c2

Browse files
authored
Update CONFIGDOC.md
1 parent 2bf9609 commit b76d7c2

File tree

1 file changed

+19
-35
lines changed

1 file changed

+19
-35
lines changed

CONFIGDOC.md

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -34,68 +34,52 @@ If you need to specify several MATLAB commands, consider writing a MATLAB script
3434
Test artifacts are not autogenerated if you choose to run tests using this build step. You can generate your desired test artifacts by configuring the test runner in the script or function that you invoke from the **Command** box.
3535

3636
## Freestyle Project Setup
37-
To configure the plugin for a freestyle project, follow these steps:
37+
To configure the plugin for a freestyle project, specify the location where MATLAB is installed as well as the required build steps.
3838

3939
1) In the **Build Environment** section of the project configuration window, select **Use MATLAB Version**. Then, enter the value returned by the **matlabroot** function in the **MATLAB root** box.
4040

4141
![build_environment](https://user-images.githubusercontent.com/48831250/76798534-23bc5a80-67a6-11ea-9a48-861cbbc7b0ba.png)
4242

43-
2) Add the required build steps.
43+
2) Add the required build steps:
4444
* If you add the [**Run MATLAB Tests**](#run-matlab-tests) build step, select check boxes for the artifacts be generated in the project workspace.
4545
* If you add the [**Run MATLAB Command**](#run-matlab-command) build step, enter your commands in the **Command** box.
4646

4747
## Multi-Configuration Project Setup
48-
In addition to freestyle projects, the Jenkins plugin for MATLAB supports [multi-configuration (matrix) projects](https://wiki.jenkins.io/display/JENKINS/Building+a+matrix+project). Multi-configuration projects are useful when builds include similar steps. For example:
48+
In addition to freestyle projects, the plugin supports [multi-configuration (matrix) projects](https://wiki.jenkins.io/display/JENKINS/Building+a+matrix+project). Multi-configuration projects are useful when builds include similar steps. For example:
4949
* The same test suite is run on different platforms (Windows, Linux, and Mac).
5050
* The same test suite is run using different versions of MATLAB.
5151

52-
As in a freestyle project, you can run your tests in automatic or custom mode within a multi-configuration project. The configuration requires you to specify the location where MATLAB is installed as well as the test execution mode. You should also add user-defined axes in the **Configuration Matrix** to specify the duplicating build steps.
52+
To configure the plugin for a multi-configuration project, specify the location where MATLAB is installed as well as the required build steps. In addition, add user-defined axes in the **Configuration Matrix** section to specify the duplicating build steps.
5353

54-
### Run MATLAB Tests
55-
56-
To configure the plugin for a matrix build where tests run automatically in multiple MATLAB versions, create a multi-configuration project and follow these steps:
57-
58-
![build_environment_matrix](https://user-images.githubusercontent.com/48831250/76800665-87488700-67aa-11ea-9dbd-3c3ab518afa7.png)
54+
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 to run the same set of tests.
5955

6056
![axis_version](https://user-images.githubusercontent.com/48831250/76800706-9a5b5700-67aa-11ea-98f0-25f2b7f3658c.png)
61-
6257
![axis_version_testtag](https://user-images.githubusercontent.com/48831250/76800736-aa733680-67aa-11ea-86a7-a984d5795e11.png)
6358

6459

65-
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 to run the same set of tests.
60+
Add a user-defined axis in the **Configuration Matrix** to represent the MATLAB versions in the build.
6661

6762

68-
69-
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.
70-
63+
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.
7164

7265

73-
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.
74-
75-
**Note:** Producing a PDF test report is not currently supported on MacOS platforms.
66+
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.
7667

77-
### Run MATLAB Command
68+
![build_environment_matrix](https://user-images.githubusercontent.com/48831250/76800665-87488700-67aa-11ea-9dbd-3c3ab518afa7.png)
7869

79-
To configure the matrix build where you can customize the MATLAB test execution, create a multi-configuration project and follow these steps:
70+
In the **Run MATLAB Tests** section of the project, use the **VERSION** axis to specify the locations where MATLAB is installed.
71+
3) Add the required build steps:
72+
* If you add the [**Run MATLAB Tests**](#run-matlab-tests) build step, select check boxes for the artifacts be generated in the project workspace.
73+
* If you add the [**Run MATLAB Command**](#run-matlab-command) build step, enter your commands in the **Command** box.
8074

8175
![run_matlab_command_matrix](https://user-images.githubusercontent.com/48831250/76800855-e3131000-67aa-11ea-99c8-f18b811eea6f.png)
76+
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.
8277

8378

84-
1) Add a user-defined axis in the **Configuration Matrix** to represent the MATLAB versions in the build.
85-
86-
87-
88-
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.
89-
90-
91-
92-
3) In the **Run MATLAB Tests** section of the project, use the **VERSION** axis to specify the locations where MATLAB is installed.
93-
94-
95-
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.
96-
79+
**Note:**
80+
* For a user-defined axis named **VAR**, **$VAR** and **${VAR}** are both valid formats for accessing the values.
9781

98-
**Notes:**
99-
1) For a user-defined axis named **VAR**, **$VAR** and **${VAR}** are both valid formats for accessing the values.
82+
* A multi-configuration project creates a separate workspace for each user-defined axis value. If you specify the full paths to where MATLAB is installed as axis values, Jenkins fails to create separate workspaces and fails the build.
10083

101-
2) A multi-configuration project creates a separate workspace for each user-defined axis value. If you specify the full paths to where MATLAB is installed as axis values, Jenkins fails to create separate workspaces and fails the build.
84+
## See Also
85+
[Run MATLAB Tests on Jenkins Server](/examples/run-matlab-tests.md)

0 commit comments

Comments
 (0)