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

Commit feae4ce

Browse files
authored
Update CONFIGDOC.md
1 parent a28575f commit feae4ce

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

CONFIGDOC.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ You can use the Jenkins™ plugin for MATLAB® in freestyle and multi-con
77
- [Multi-Configuration Project Setup](#multi-configuration-project-setup)
88

99
## Plugin Build Steps
10-
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.
10+
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.
1111

1212
### Run MATLAB Tests
13-
This build step uses a default setting to run tests written using the MATLAB Unit Testing Framework and/or Simulink® Test™. If your source code is organized as files and folders within a MATLAB project, then the plugin includes any test files in the project that have been labeled as **Test**. If your code does not leverage a project or uses a MATLAB release before R2019a, the plugin includes all tests in the current Jenkins workspace including its subfolders.
13+
This build step uses a default setting to run tests authored using the MATLAB Unit Testing Framework and/or Simulink® Test™. If your source code is organized as files and folders within a MATLAB project, then the plugin includes any test files in the project that have been labeled as **Test**. If your code does not leverage a MATLAB project or uses a MATLAB release before R2019a, then the plugin includes all tests in the current Jenkins workspace including its subfolders.
1414

1515
If you use a source code management (SCM) system such as Git™, then your project must include the appropriate SCM configuration to check out the code before it 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.
1616

17-
The automatic test execution enables you to generate different types of test artifacts. To publish the test results, you can use these artifacts with other Jenkins plugins. The selected artifacts are saved in the **matlabTestArtifacts** folder of the Jenkins workspace. If you do not select any of the test artifact check boxes, the folder is not created. However, the tests still run and test failures fail the build.
17+
The **Run MATLAB Tests** build step enables you to easily generate different types of test artifacts. To publish the test results, you can use these artifacts with other Jenkins plugins. The selected artifacts are saved in the **matlabTestArtifacts** folder of the Jenkins workspace. If you do not select any of the test artifact check boxes, the folder is not created. However, the tests still run and test failures fail the build.
1818

1919
![run_matlab_tests](https://user-images.githubusercontent.com/48831250/76800820-d2629a00-67aa-11ea-9fa7-c466e8c17f27.png)
2020

21-
The **Run MATLAB Tests** step produces a MATLAB script file named **runMatlabTests.m** in the Jenkins workspace. The plugin uses this file to run the tests and generate the test artifacts. You can review the contents of the script to understand the testing workflow.
21+
The **Run MATLAB Tests** build step produces a MATLAB script file named **runMatlabTests.m** in the Jenkins workspace. The plugin uses this file to run the tests and generate the test artifacts. You can review the contents of the script to understand the testing workflow.
2222

2323
**Note:** Producing a PDF test report is not currently supported on MacOS platforms.
2424

2525
### Run MATLAB Command
26-
The **Run MATLAB Command** build step enables you to specify custom MATLAB commands tailored to your specific needs. For example, you can use this build step to customize your test run.
26+
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.
2727

2828
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.
2929

@@ -41,30 +41,30 @@ To configure the plugin for a freestyle project, specify the location where MATL
4141
![build_environment](https://user-images.githubusercontent.com/48831250/76798534-23bc5a80-67a6-11ea-9a48-861cbbc7b0ba.png)
4242

4343
2) Add the required build steps in the **Build** section:
44-
* If you add the [**Run MATLAB Tests**](#run-matlab-tests) build step, select check boxes for the artifacts be generated in the project workspace.
44+
* 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.
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
4848
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).
50-
* The same test suite is run using different versions of MATLAB.
50+
* The same test suite is run against different versions of MATLAB.
5151

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.
52+
To configure the plugin for a multi-configuration project, specify the locations 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

5454
1) Add a user-defined axis in the **Configuration Matrix** section to represent the MATLAB versions in the build. Specify the name of the axis in the **Name** box and its values in the **Values** box. Separate the values with a space. In this example, four MATLAB versions are specified to run the same set of tests.
5555

5656
![axis_version](https://user-images.githubusercontent.com/48831250/76800706-9a5b5700-67aa-11ea-98f0-25f2b7f3658c.png)
5757

58-
You can specify several axes in the **Configuration Matrix** section. For example, add the **TEST_TAG** axis specifying the possible test tags for a group of tests.
58+
You can define several axes in the **Configuration Matrix** section. For example, add the TEST_TAG axis specifying the possible test tags for a group of tests.
5959

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

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 step.
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.
6363

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

6666
3) Add the required build steps in the **Build** section:
67-
* If you add the [**Run MATLAB Tests**](#run-matlab-tests) build step, select check boxes for the artifacts be generated in the project workspace.
67+
* 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.
6868
* 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:
6969

7070
![run_matlab_command_matrix](https://user-images.githubusercontent.com/48831250/76800855-e3131000-67aa-11ea-99c8-f18b811eea6f.png)

0 commit comments

Comments
 (0)