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

Commit efc0bf3

Browse files
authored
Update README.md
1 parent 892bb57 commit efc0bf3

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
11
# Jenkins MATLAB Plugin
22

3-
The Jenkins plugin for MATLAB® enables you to easily run your MATLAB tests and generate test artifacts in formats such as JUnit, TAP, and Cobertura code coverage reports.
3+
The Jenkins plugin for MATLAB® enables you to easily run your MATLAB tests and generate test artifacts in formats such as *JUnit*, *TAP*, and *Cobertura* code coverage reports. You can run tests in either *automatic* or *custom* mode.
4+
45
## Configure Plugin for Freestyle Project
56
To configure the plugin for a freestyle project, select **Run MATLAB Tests** from the **Add build step** list.
67

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

910
![new_default_plugin_page](https://user-images.githubusercontent.com/47204011/55624213-dcba9c80-57c2-11e9-85e6-abb6ae03534e.png)
10-
11-
You can use the plugin as part of the Jenkins build step to run MATLAB tests in two distinct modes:
12-
* Automatic
13-
* Custom
14-
11+
1512
To run your tests, enter the value returned by the **matlabroot** function in the **MATLAB root** field.
1613

1714
![new_enter_matlabroot](https://user-images.githubusercontent.com/47204011/55624374-45097e00-57c3-11e9-96e1-5fa0fc966767.png)
1815

1916
### Option 1: Freestyle Project with Automatic Test Mode
20-
This option runs the tests written using the MATLAB Unit Testing Framework and/or Simulink Test. If your files and folders are organized in a project, the plugin will locate all 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 discover all tests in the current Jenkins workspace including the subfolders.
17+
This option runs the tests written using the MATLAB Unit Testing Framework and/or Simulink&reg Test. If your files and folders are organized in a project, the plugin will locate all 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 discover all tests in the current Jenkins workspace including the subfolders.
2118

2219
If you use a source code management (SCM) system such as Git, then your job must include the appropriate SCM configuration to check out the code before if can invoke the MATLAB plugin. If you do not use any SCM systems to manage your code, then an additional build step is required to ensure that the code is available in the Jenkins workspace before the build starts.
2320

0 commit comments

Comments
 (0)