You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 27, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: CONFIGDOC.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
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.
2
2
3
-
-[Use MATLAB for Build](#use-matlab-for-build)
3
+
-[Add MATLAB to System Path](#add-matlab-to-system-path)
4
4
-[Specify Build Steps](#specify-build-steps)
5
5
-[Run MATLAB Tests](#run-matlab-tests)
6
6
-[Run MATLAB Command](#run-matlab-command)
7
7
-[Set Up Freestyle Project](#set-up-freestyle-project)
8
8
-[Set Up Multi-Configuration Project](#set-up-multi-configuration-project)
9
9
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.
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.
16
16
17
17
## Specify Build Steps
18
18
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
31
31
**Note:** Producing a PDF test report is not currently supported on MacOS platforms.
32
32
33
33
### 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.
35
35
36
36
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.
37
37
@@ -44,8 +44,8 @@ Test artifacts are not autogenerated if you choose to run tests using this build
44
44
## Set Up Freestyle Project
45
45
To configure the plugin for a freestyle project, specify the location where MATLAB is installed as well as the required build steps.
46
46
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.)
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.
0 commit comments