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

Commit 4f995ab

Browse files
authored
react to Andy's comments
1 parent 4fe3b76 commit 4f995ab

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

CONFIGDOC.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
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-
- [Plugin Build Steps](#plugin-build-steps)
3+
- [Use MATLAB for Build](#use-matlab-for-build)
4+
- [Specify Build Steps](#specify-build-steps)
45
- [Run MATLAB Tests](#run-matlab-tests)
56
- [Run MATLAB Command](#run-matlab-command)
6-
- [Freestyle Project Setup](#freestyle-project-setup)
7-
- [Multi-Configuration Project Setup](#multi-configuration-project-setup)
7+
- [Set Up Freestyle Project](#set-up-freestyle-project)
8+
- [Set Up Multi-Configuration Project](#set-up-multi-configuration-project)
89

9-
## Plugin Build Steps
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.
12+
13+
![matlab_path](https://user-images.githubusercontent.com/48831250/76883191-1c528b00-6852-11ea-9242-7d143f8a5c46.png)
14+
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.
16+
17+
## Specify Build Steps
1018
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.
1119

1220
### Run MATLAB Tests
@@ -33,18 +41,18 @@ If you need to specify several MATLAB commands, consider writing a MATLAB script
3341

3442
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.
3543

36-
## Freestyle Project Setup
44+
## Set Up Freestyle Project
3745
To configure the plugin for a freestyle project, specify the location where MATLAB is installed as well as the required build steps.
3846

39-
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.
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.
4048

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

4351
2) Add the required build steps in the **Build** section:
4452
* If you add the [**Run MATLAB Tests**](#run-matlab-tests) build step, select check boxes for the artifacts to be generated in the project workspace.
4553
* If you add the [**Run MATLAB Command**](#run-matlab-command) build step, enter your commands in the **Command** box.
4654

47-
## Multi-Configuration Project Setup
55+
## Set Up Multi-Configuration Project
4856
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:
4957
* The same test suite is run on different platforms (Windows, Linux, and Mac).
5058
* The same test suite is run against different versions of MATLAB.
@@ -59,15 +67,15 @@ You can define several axes in the **Configuration Matrix** section. For example
5967

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

62-
2) In the **Build Environment** section, include the user-defined axis name in the **MATLAB root** box to specify the locations where MATLAB is installed. In this example, **$VERSION** 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. In this example, **$VERSION** in the **MATLAB root** will be replaced by one axis value per build iteration.
6371

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

6674
3) Add the required build steps in the **Build** section:
6775
* If you add the [**Run MATLAB Tests**](#run-matlab-tests) build step, select check boxes for the artifacts to be generated in the project workspace.
6876
* If you add the [**Run MATLAB Command**](#run-matlab-command) build step, enter your commands in the **Command** box. You can use the user-defined axes to create your commands. For example:
6977

70-
![run_matlab_command_matrix](https://user-images.githubusercontent.com/48831250/76800855-e3131000-67aa-11ea-99c8-f18b811eea6f.png)
78+
![run_matlab_command_matrix](https://user-images.githubusercontent.com/48831250/76883848-21fca080-6853-11ea-8ad3-89f85b997608.png)
7179

7280
**Note:**
7381
* For a user-defined axis named **VAR**, **$VAR** and **${VAR}** are both valid formats for accessing the values.

0 commit comments

Comments
 (0)