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

Commit 47e4576

Browse files
authored
Update CONFIGDOC.md
1 parent 4f995ab commit 47e4576

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

CONFIGDOC.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
You can use the Jenkins™ plugin for MATLAB® in freestyle and multi-configuration projects. This guide demonstrates how to run MATLAB code on Jenkins, considering a Microsoft® Windows® platform.
22

3-
- [Use MATLAB for Build](#use-matlab-for-build)
3+
- [Add MATLAB to System Path](#add-matlab-to-system-path)
44
- [Specify Build Steps](#specify-build-steps)
55
- [Run MATLAB Tests](#run-matlab-tests)
66
- [Run MATLAB Command](#run-matlab-command)
77
- [Set Up Freestyle Project](#set-up-freestyle-project)
88
- [Set Up Multi-Configuration Project](#set-up-multi-configuration-project)
99

10-
## Use MATLAB for Build
11-
Once you install the plugin on Jenkins, the **Use MATLAB version** checkbox is displayed in the **Build Environment** section of the project configuration window. Selecting the checkbox instructs Jenkins to use MATLAB for your build.
10+
## Add MATLAB to System Path
11+
Once you install the plugin on Jenkins, the **Use MATLAB version** checkbox is displayed in the **Build Environment** section of the project configuration window.
1212

1313
![matlab_path](https://user-images.githubusercontent.com/48831250/76883191-1c528b00-6852-11ea-9242-7d143f8a5c46.png)
1414

15-
When you select the **Use MATLAB version** checkbox, you can specify the full path to the MATLAB installation folder that is used for the build. The specified directory in the **MATLAB root** box is prepended to the PATH environment variable, and the specified MATLAB version is used to perform the build. You must not leave the **MATLAB root** box blank if no MATLAB directory exists on the path. If you leave the box blank, then the system tries to use the MATLAB directory closest to the top of the system path.
15+
Select the **Use MATLAB version** checkbox to specify the full path to the MATLAB root folder that should be used for the build. The specified directory in the **MATLAB root** box is prepended to the PATH environment variable, and the matlab.exe file in the bin subdirectory is used to perform the build. You must not leave the **MATLAB root** box blank if no MATLAB directory exists on the path. If you do not select the checkbox or if you leave the text box blank, then the system tries to use the MATLAB directory closest to the top of the system path.
1616

1717
## Specify Build Steps
1818
When you set up the **Build** section of the project configuration window, the plugin provides you with the **Run MATLAB Tests** and **Run MATLAB Command** build steps.
@@ -31,7 +31,7 @@ The **Run MATLAB Tests** build step produces a MATLAB script file named **runMat
3131
**Note:** Producing a PDF test report is not currently supported on MacOS platforms.
3232

3333
### Run MATLAB Command
34-
The **Run MATLAB Command** build step enables you to specify MATLAB commands tailored to your specific needs. For example, you can use this build step to customize your test run.
34+
The **Run MATLAB Command** build step enables you to specify MATLAB commands tailored to your specific needs. For example, you can use this build step to customize your test run or add a different build step to your pipeline.
3535

3636
If you specify more than one MATLAB command, use a comma or semicolon to separate the commands. The build fails if the execution of any command results in an error.
3737

@@ -44,8 +44,8 @@ Test artifacts are not autogenerated if you choose to run tests using this build
4444
## Set Up Freestyle Project
4545
To configure the plugin for a freestyle project, specify the location where MATLAB is installed as well as the required build steps.
4646

47-
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.
48-
47+
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. (You can skip this step if MATLAB has already been added to the path on the build agent.)
48+
4949
![build_environment](https://user-images.githubusercontent.com/48831250/76798534-23bc5a80-67a6-11ea-9a48-861cbbc7b0ba.png)
5050

5151
2) Add the required build steps in the **Build** section:
@@ -67,7 +67,9 @@ You can define several axes in the **Configuration Matrix** section. For example
6767

6868
![axis_version_testtag](https://user-images.githubusercontent.com/48831250/76800736-aa733680-67aa-11ea-86a7-a984d5795e11.png)
6969

70-
2) In the **Build Environment** section, select **Use MATLAB version** and then specify the locations where MATLAB is installed using the user-defined axis name. In this example, **$VERSION** in the **MATLAB root** will be replaced by one axis value per build iteration.
70+
2) In the **Build Environment** section, select **Use MATLAB version** and then specify the locations where MATLAB is installed using the user-defined axis name. (You can skip this step if MATLAB has already been added to the path on the build agents.)
71+
72+
In this example, **$VERSION** in the **MATLAB root** will be replaced by one axis value per build iteration.
7173

7274
![build_environment_matrix](https://user-images.githubusercontent.com/48831250/76800665-87488700-67aa-11ea-9dbd-3c3ab518afa7.png)
7375

0 commit comments

Comments
 (0)