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

Commit a2c4aee

Browse files
authored
update link text
1 parent 5433a33 commit a2c4aee

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

CONFIGDOC.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ When you define a [Jenkins™ Pipeline](https://www.jenkins.io/doc/book/pipe
1010
- [Set Up Multi-Configuration Project](#set-up-multi-configuration-project)
1111
- [Set Up Pipeline Project](#set-up-pipeline-project)
1212
- [Add MATLAB to System Path](#add-matlab-to-system-path)
13-
- [Use `RunMATLABCommand` Step](#use-runmatlabcommand-step)
14-
- [Use `RunMATLABTests` Step](#use-runmatlabtests-step)
13+
- [Use `runMATLABCommand` Step](#use-runmatlabcommand-step)
14+
- [Use `runMATLABTests` Step](#use-runmatlabtests-step)
1515
- [Use MATLAB in Matrix Build](#use-matlab-in-matrix-build)
1616

1717
## Configure Plugin in Web UI
@@ -79,7 +79,7 @@ To configure the plugin for a freestyle project, specify the location where MATL
7979
* If you add the [**Run MATLAB Command**](#run-matlab-command) build step, enter your commands in the **Command** box.
8080

8181
## Set Up Multi-Configuration Project
82-
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:
82+
The plugin supports [multi-configuration (matrix) projects](https://plugins.jenkins.io/matrix-project/). Multi-configuration projects are useful when builds include similar steps. For example:
8383
* The same test suite is run on different platforms (Windows, Linux, and macOS).
8484
* The same test suite is run against different versions of MATLAB.
8585

@@ -93,7 +93,7 @@ You can define several axes in the **Configuration Matrix** section. For example
9393

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

96-
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** box will be replaced by one axis value per build iteration.
96+
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** box is replaced by one axis value per build iteration.
9797

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

@@ -143,7 +143,7 @@ pipeline {
143143
}
144144
}
145145
```
146-
If you define your Pipeline using scripted syntax, set the PATH environment variable in the `node` block. For example:
146+
If you define your Pipeline using Scripted Pipeline syntax, set the PATH environment variable in the `node` block. For example:
147147

148148
```groovy
149149
// Scripted Pipeline
@@ -196,7 +196,7 @@ When you use the `runMATLABCommand` step, all of the required files must be on t
196196

197197
### Use `runMATLABTests` Step
198198

199-
Use the `runMATLABTests` step in your Pipeline to run all tests in your MATLAB project and generate artifacts. MATLAB includes any files in your project that have a `Test` label. If your Pipeline does not leverage a MATLAB project or uses a MATLAB release before R2019a, then MATLAB includes all tests in the the root of your repository including its subfolders.
199+
Use the `runMATLABTests` step in your Pipeline to run all tests in your MATLAB project and generate artifacts. MATLAB includes any files in your project that have a `Test` label. If your Pipeline does not leverage a MATLAB project or uses a MATLAB release before R2019a, then MATLAB includes all tests in the the root of your repository, including its subfolders.
200200

201201
For example, in your `Jenkinsfile`, define a Declarative Pipeline to run the tests in your project and fail the build if any of the tests fails.
202202

@@ -227,7 +227,7 @@ node {
227227

228228
To generate artifacts using the `runMATLABTests` step, provide the step with one or more name-value pair arguments to specify the artifacts and the locations to save them. Use a colon to separate names and values.
229229

230-
For example, define a Declarative Pipeline to run the tests in your MATLAB project automatically, and then generate a JUnit test results report and a Cobertura code coverage report at specified locations on the build agent.
230+
For example, define a Declarative Pipeline to run the tests in your MATLAB project, and then generate a JUnit test results report and a Cobertura code coverage report at specified locations on the build agent.
231231

232232

233233
```groovy
@@ -265,7 +265,7 @@ node {
265265
| testResultsPDF | Path to write test results report in PDF format (currently not supported on macOS platforms).<br/>**Example:** `'test-results/results.pdf'` |
266266
| testResultsTAP | Path to write test results report in TAP format.<br/>**Example:** `'test-results/results.tap'` |
267267
| testResultsJUnit | Path to write test results report in JUnit XML format.<br/>**Example:** `'test-results/results.xml'` |
268-
| testResultsSimulinkTest | Path to export Simulink Test&trade; Manager results in MLDATX format (requires Simulink Test license and is supported in MATLAB R2019a or later).<br/>**Example:** `'test-results/results.mldatx'` |
268+
| testResultsSimulinkTest | Path to export Simulink Test Manager results in MLDATX format (requires Simulink Test license and is supported in MATLAB R2019a or later).<br/>**Example:** `'test-results/results.mldatx'` |
269269
| codeCoverageCobertura | Path to write code coverage report in Cobertura XML format.<br/>**Example:** `'code-coverage/coverage.xml'` |
270270
| modelCoverageCobertura | Path to write model coverage report in Cobertura XML format (requires Simulink Coverage™ license and is supported in MATLAB R2018b or later).<br/>**Example:** `'model-coverage/coverage.xml'` |
271271

0 commit comments

Comments
 (0)