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

Commit eb4815f

Browse files
authored
Update CONFIGDOC.md
1 parent 0432a3f commit eb4815f

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

CONFIGDOC.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ When you define an automated pipeline of tasks in Jenkins™, whether in the
2020
- [Use the `runMATLABTests` Step](#use-the-runmatlabtests-step)
2121
- [Use the `runMATLABCommand` Step](#use-the-runmatlabcommand-step)
2222
- [Use MATLAB in Matrix Build](#use-matlab-in-matrix-build)
23+
- [Access Visualized MATLAB Build and Test Results](#access-visualized-matlab-build-and-test-results)
24+
- [Access Visualized Build Results](#access-visualized-build-results)
25+
- [Access Visualized Test Results](#access-visualized-test-results)
2326
- [Register MATLAB as Jenkins Tool](#register-matlab-as-jenkins-tool)
2427
- [Register Preinstalled MATLAB Version](#register-preinstalled-matlab-version)
2528
- [Automatically Install MATLAB Using MATLAB Package Manager](#automatically-install-matlab-using-matlab-package-manager)
@@ -78,9 +81,7 @@ You can specify build options for your MATLAB build by first selecting **Build o
7881

7982
MATLAB exits with exit code 0 if the specified tasks run without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the step to fail.
8083

81-
Starting in R2024a, you can view the results of running a MATLAB build in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page.
82-
83-
![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4)
84+
You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [Access Visualized Build Results](#access-visualized-build-results).
8485

8586
#### Run MATLAB Tests
8687
The **Run MATLAB Tests** build step lets you run MATLAB and Simulink tests and generate artifacts, such as test results in JUnit-style XML format and code coverage results in Cobertura XML format. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your build does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders.
@@ -283,7 +284,7 @@ node {
283284
}
284285
```
285286

286-
Starting in R2024a, you can view the results of running a MATLAB build in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page.
287+
You can access the results of running a MATLAB build directly from your Jenkins interface. For more information, see [Access Visualized Build Results](#access-visualized-build-results).
287288

288289
### Use the `runMATLABTests` Step
289290
Use the `runMATLABTests` step in your pipeline to run MATLAB and Simulink tests and generate test and coverage artifacts. By default, the plugin includes any test files in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html) that have a `Test` label. If your pipeline does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the plugin includes all tests in the root of your repository and in any of its subfolders.
@@ -442,7 +443,7 @@ pipeline {
442443
}
443444
```
444445

445-
You can also invoke MATLAB as a Jenkins tool when you perform a matrix build in your pipeline project. This example uses three MATLAB versions (specified in an `axis` block using their tool names) to run a set of MATLAB commands and tests. For more information about using tools in pipeline projects, see [Use MATLAB as a Tool in Pipeline Project](#use-matlab-as-a-tool-in-pipeline-project).
446+
You can also invoke MATLAB as a Jenkins tool when you perform a matrix build in your pipeline project. This example uses three MATLAB versions (specified in an `axis` block using their tool names) to run a set of MATLAB commands and tests. For more information about using tools in pipeline projects, see [Use MATLAB as a Tool in Pipeline Project](#use-matlab-as-a-tool-in-pipeline-project).
446447

447448
```groovy
448449
// Declarative Pipeline
@@ -479,6 +480,16 @@ pipeline {
479480
}
480481
```
481482

483+
## Access Visualized MATLAB Build and Test Results
484+
You can access the results of running a MATLAB build and the results of running MATLAB and Simulink tests directly from your Jenkins interface.
485+
486+
### Access Visualized Build Results
487+
Starting in R2024a, if you run a MATLAB build using the **Run MATLAB Build** or `runMATLABBuild` step, you can view the MATLAB build results in your Jenkins interface. After your build runs, the Jenkins build summary page displays the number of tasks that ran, failed, and were skipped. You can click the **MATLAB Build Results** link on the page to access the table of task results. The table provides information about each task that was part of the MATLAB build. Click a task name in the table to go to the relevant build log information on the **Console Output** page.
488+
489+
![Table of MATLAB build results including three tasks. Each table row includes a clickable task name, its status, description, and duration.](https://github.com/user-attachments/assets/97fd7dc5-b00f-45bc-97a8-990ce26123d4)
490+
491+
### Access Visualized Test Results
492+
482493
## Register MATLAB as Jenkins Tool
483494
When you run MATLAB code and Simulink models as part of your automated pipeline of tasks, Jenkins invokes MATLAB as an external program. When you configure your project, you can explicitly specify the MATLAB version that Jenkins invokes by providing the path to the preferred MATLAB root folder. For example, you can use an `environment` block in your `Jenkinsfile` to specify a MATLAB root folder for your pipeline project.
484495

0 commit comments

Comments
 (0)