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

Commit 640e6e2

Browse files
authored
Update per review feedback
1 parent 3b17293 commit 640e6e2

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

CONFIGDOC.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ If the build agent already has your desired MATLAB on the path, then you are not
3030

3131
| Platform | Path to MATLAB Root Folder |
3232
|--------------|---------------------------------|
33-
| Windows® | C:\Program Files\MATLAB\R2019a |
34-
| Linux® | /usr/local/MATLAB/R2019a |
35-
| Mac | /Applications/MATLAB_R2019a.app |
33+
| Windows® | C:\Program Files\MATLAB\R2020a |
34+
| Linux® | /usr/local/MATLAB/R2020a |
35+
| macOS | /Applications/MATLAB_R2020a.app |
3636

3737
### Specify Build Steps
3838
When you set up the **Build** section of the project configuration window, the plugin provides you with the **Run MATLAB Command** and **Run MATLAB Tests** build steps.
3939

40-
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 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.
40+
If you use a source code management (SCM) system such as Git™, then your project should include the appropriate SCM configuration to check out the code before it can invoke the plugin. If you do not use any SCM systems to manage your code, then an additional build step might be required to ensure that the code is available in the Jenkins workspace before the build starts.
4141

4242
#### Run MATLAB Command
4343
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 or add a different build step to your pipeline.
@@ -65,7 +65,7 @@ The **Run MATLAB Tests** build step produces a MATLAB script file named `runMatl
6565
**Note:**
6666
* The plugin does not create the `matlabTestArtifacts` folder if the name of the folder does not appear in any of the displayed **File path** boxes.
6767

68-
* Producing a PDF test report is not currently supported on Mac platforms.
68+
* Producing a PDF test report is not currently supported on macOS platforms.
6969

7070
## Set Up Freestyle Project
7171
To configure the plugin for a freestyle project, specify the location where MATLAB is installed as well as the required build steps.
@@ -80,7 +80,7 @@ To configure the plugin for a freestyle project, specify the location where MATL
8080

8181
## Set Up Multi-Configuration Project
8282
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:
83-
* The same test suite is run on different platforms (Windows, Linux, and Mac).
83+
* 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

8686
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.
@@ -104,7 +104,7 @@ You can define several axes in the **Configuration Matrix** section. For example
104104
![run_matlab_command_matrix](https://user-images.githubusercontent.com/48831250/76883848-21fca080-6853-11ea-8ad3-89f85b997608.png)
105105

106106
**Note:**
107-
* Both **$VAR** and **${VAR}** are valid formats for accessing the values of the user-defined axis **VAR**. On Mac platforms, the **${VAR}** format is recommended.
107+
* Both **$VAR** and **${VAR}** are valid formats for accessing the values of the user-defined axis **VAR**. On macOS platforms, the **${VAR}** format is recommended.
108108

109109
* A multi-configuration project creates a separate workspace for each user-defined axis value. If you specify the full paths to where MATLAB is installed as axis values, Jenkins fails to create separate workspaces and fails the build.
110110

@@ -122,16 +122,16 @@ You also can define your Pipeline directly in the project configuration window.
122122
### Add MATLAB to System Path
123123
When Jenkins executes MATLAB-related steps in your Pipeline, it uses the first MATLAB version on the system path. If the PATH environment variable of the build agent does not include any MATLAB versions, you must update the variable with the MATLAB root folder that should be used for the build.
124124

125-
To update the system PATH environment variable using Declarative Pipeline syntax, use an `environment` block in your `Jenkinsfile`. For example, prepend MATLAB R2019a to the system PATH environment variable and use it to run your command.
125+
To update the system PATH environment variable using Declarative Pipeline syntax, use an `environment` block in your `Jenkinsfile`. For example, prepend MATLAB R2020a to the system PATH environment variable and use it to run your command.
126126

127127
```groovy
128128
// Declarative Pipeline
129129
pipeline {
130130
agent any
131131
environment {
132-
PATH = "C:\\Program Files\\MATLAB\\R2019a\\bin;${PATH}" // Windows agent
133-
// PATH = "/usr/local/MATLAB/R2019a/bin:${PATH}" // Linux agent
134-
// PATH = "/Applications/MATLAB_R2019a.app/bin:${PATH}" // Mac agent
132+
PATH = "C:\\Program Files\\MATLAB\\R2020a\\bin;${PATH}" // Windows agent
133+
// PATH = "/usr/local/MATLAB/R2020a/bin:${PATH}" // Linux agent
134+
// PATH = "/Applications/MATLAB_R2020a.app/bin:${PATH}" // macOS agent
135135
}
136136
stages{
137137
stage('Run MATLAB Command') {
@@ -148,9 +148,9 @@ If you define your Pipeline using scripted syntax, set the PATH environment vari
148148
```groovy
149149
// Scripted Pipeline
150150
node {
151-
env.PATH = "C:\\Program Files\\MATLAB\\R2019a\\bin;${env.PATH}" //Windows agent
152-
// env.PATH = "/usr/local/MATLAB/R2019a/bin:${env.PATH}" //Linux agent
153-
// env.PATH = "/Applications/MATLAB_R2019a.app/bin:${env.PATH}" //Mac agent
151+
env.PATH = "C:\\Program Files\\MATLAB\\R2020a\\bin;${env.PATH}" //Windows agent
152+
// env.PATH = "/usr/local/MATLAB/R2020a/bin:${env.PATH}" //Linux agent
153+
// env.PATH = "/Applications/MATLAB_R2020a.app/bin:${env.PATH}" //macOS agent
154154
runMATLABCommand "disp('Hello World!')"
155155
}
156156
```
@@ -262,7 +262,7 @@ node {
262262

263263
| Name | Value |
264264
|------------------------- |---------------------------------------------------------------------------------------------------------------------------- |
265-
| testResultsPDF | Path to write test results report in PDF format (currently not supported on Mac platforms).<br/>**Example:** `'test-results/results.pdf'` |
265+
| 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'` |
268268
| 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'` |
@@ -271,9 +271,9 @@ node {
271271

272272

273273
## Use MATLAB in Matrix Build
274-
Similar to multi-configuration projects, you can use MATLAB as part of a [matrix](https://www.jenkins.io/doc/book/pipeline/syntax/#declarative-matrix) build in Pipeline projects. For example, you can define a Declarative Pipeline to run your test suite on different platforms or against different versions of MATLAB. (Matrix build is not supported in Scripted Pipelines.)
274+
Similar to multi-configuration projects, you can use MATLAB as part of a [matrix](https://www.jenkins.io/doc/book/pipeline/syntax/#declarative-matrix) build in Pipeline projects. For example, you can define a Pipeline to run your test suite on different platforms or against different versions of MATLAB.
275275

276-
Your Pipeline must have a `matrix` section to define the possible name-value combinations that should run in parallel. This example shows how to define a Pipeline to run your MATLAB code and generate test artifacts using MATLAB R2018b, R2019a, and R2020a.
276+
This example shows how to define a Declarative Pipeline to run your MATLAB code and generate test artifacts using MATLAB R2018b, R2019a, and R2020a. The Pipeline has a `matrix` section to define the possible name-value combinations that should run in parallel.
277277

278278
```groovy
279279
// Declarative Pipeline
@@ -289,7 +289,7 @@ pipeline {
289289
axes {
290290
axis {
291291
name 'MATLAB_VERSION'
292-
values 'R2018b', 'R2019a', 'R2019b'
292+
values 'R2018b', 'R2019a', 'R2020a'
293293
}
294294
}
295295
stages {

0 commit comments

Comments
 (0)