From 93ad9b7a4082a980709500cff35306df9bb2ea0c Mon Sep 17 00:00:00 2001 From: Johan Pereira <2079700+jwpereira@users.noreply.github.com> Date: Tue, 18 May 2021 11:28:59 -0400 Subject: [PATCH 1/4] Doc v0 -> v1 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 93c2895..9fbdbcf 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ jobs: - name: Check out repository uses: actions/checkout@v2 - name: Run script - uses: matlab-actions/run-command@v0 + uses: matlab-actions/run-command@v1 with: command: myscript ``` @@ -44,15 +44,15 @@ jobs: - name: Check out repository uses: actions/checkout@v2 - name: Install MATLAB - uses: matlab-actions/setup-matlab@v0 + uses: matlab-actions/setup-matlab@v1 - name: Run commands - uses: matlab-actions/run-command@v0 + uses: matlab-actions/run-command@v1 with: command: results = runtests, assertSuccess(results); ``` ## Run MATLAB Command -When you define your workflow in the `.github/workflows` directory of your repository, specify the **Run MATLAB Command** action as `matlab-actions/run-command@v0`. The action requires an input. +When you define your workflow in the `.github/workflows` directory of your repository, specify the **Run MATLAB Command** action as `matlab-actions/run-command@v1`. The action requires an input. Input | Description ------------------------- | --------------- From c726112157300e545348effa94670e9946d3286d Mon Sep 17 00:00:00 2001 From: Johan Pereira <2079700+jwpereira@users.noreply.github.com> Date: Tue, 18 May 2021 11:30:14 -0400 Subject: [PATCH 2/4] Adjust setup-matlab in doc --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9fbdbcf..69addc2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The [Run MATLAB Command](#run-matlab-command) GitHub® action enables you to - To use a self-hosted runner, you must set up a computer with MATLAB (R2013b or later) as your runner. The action uses the topmost MATLAB version on the runner's system path. -- To use a GitHub-hosted runner, you must include the [Set Up MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow to install MATLAB on the runner. Currently, this action is available only for public projects. It does not install transformation products, such as MATLAB Coder™ and MATLAB Compiler™. +- To use a GitHub-hosted runner, you must include the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow to install MATLAB on the runner. Currently, this action is available only for public projects. It does not install transformation products, such as MATLAB Coder™ and MATLAB Compiler™. ## Usage Examples Use the **Run MATLAB Command** action to run MATLAB scripts, functions, and statements. You can use this action to flexibly customize your test run or add a MATLAB related step to your workflow. @@ -29,7 +29,7 @@ jobs: ``` ### Run MATLAB Commands on GitHub-Hosted Runner -Before you run MATLAB code or Simulink models on a GitHub-hosted runner, first use the [Set Up MATLAB](https://github.com/matlab-actions/setup-matlab/) action. The action installs your specified MATLAB release (R2020a or later) on a Linux® virtual machine. If you do not specify a release, the action installs the latest release of MATLAB. +Before you run MATLAB code or Simulink models on a GitHub-hosted runner, first use the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action. The action installs your specified MATLAB release (R2020a or later) on a Linux® virtual machine. If you do not specify a release, the action installs the latest release of MATLAB. For example, install the latest release of MATLAB on a GitHub-hosted runner, and then use the **Run MATLAB Command** action to execute your MATLAB commands. @@ -43,7 +43,7 @@ jobs: steps: - name: Check out repository uses: actions/checkout@v2 - - name: Install MATLAB + - name: Set up MATLAB uses: matlab-actions/setup-matlab@v1 - name: Run commands uses: matlab-actions/run-command@v1 @@ -69,7 +69,7 @@ When you use the **Run MATLAB Command** action, you execute third-party code tha ## See Also - [Action for Running MATLAB Tests](https://github.com/matlab-actions/run-tests/) -- [Action for Installing MATLAB on GitHub-Hosted Runner](https://github.com/matlab-actions/setup-matlab/) +- [Action for Setting Up MATLAB on GitHub-Hosted Runner](https://github.com/matlab-actions/setup-matlab/) - [Continuous Integration with MATLAB and Simulink](https://www.mathworks.com/solutions/continuous-integration.html) ## Contact Us From ffe5d3b68f254854cd66639d7b4035dd7ce7cc26 Mon Sep 17 00:00:00 2001 From: Johan Pereira <2079700+jwpereira@users.noreply.github.com> Date: Tue, 18 May 2021 15:10:43 -0400 Subject: [PATCH 3/4] Doc 'install' -> 'set up' --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 69addc2..a417ee0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The [Run MATLAB Command](#run-matlab-command) GitHub® action enables you to - To use a GitHub-hosted runner, you must include the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow to install MATLAB on the runner. Currently, this action is available only for public projects. It does not install transformation products, such as MATLAB Coder™ and MATLAB Compiler™. ## Usage Examples -Use the **Run MATLAB Command** action to run MATLAB scripts, functions, and statements. You can use this action to flexibly customize your test run or add a MATLAB related step to your workflow. +Use the **Run MATLAB Command** action to run MATLAB scripts, functions, and statements. You can use this action to flexibly customize your test run or add a MATLAB related step to your workflow. ### Run MATLAB Script on Self-Hosted Runner Use a self-hosted runner to run the commands in a file named `myscript.m` in the root of your repository. @@ -54,13 +54,13 @@ jobs: ## Run MATLAB Command When you define your workflow in the `.github/workflows` directory of your repository, specify the **Run MATLAB Command** action as `matlab-actions/run-command@v1`. The action requires an input. -Input | Description -------------------------- | --------------- -`command` | (Required) Script, function, or statement to execute. If the value of `command` is the name of a MATLAB script or function, do not specify the file extension. If you specify more than one script, function, or statement, use a comma or semicolon to separate them.
**Example:** `myscript`
**Example:** `results = runtests, assertSuccess(results);` +Input | Description +------------------------- | --------------- +`command` | (Required) Script, function, or statement to execute. If the value of `command` is the name of a MATLAB script or function, do not specify the file extension. If you specify more than one script, function, or statement, use a comma or semicolon to separate them.
**Example:** `myscript`
**Example:** `results = runtests, assertSuccess(results);` MATLAB exits with exit code 0 if the specified script, function, or statement executes successfully without error. Otherwise, MATLAB terminates with a nonzero exit code, which causes the build to fail. To ensure that the build fails in certain conditions, use the [`assert`](https://www.mathworks.com/help/matlab/ref/assert.html) or [`error`](https://www.mathworks.com/help/matlab/ref/error.html) functions. -When you use this action, all of the required files must be on the MATLAB search path. If your script or function is not in the root of your repository, you can use the [`addpath`](https://www.mathworks.com/help/matlab/ref/addpath.html), [`cd`](https://www.mathworks.com/help/matlab/ref/cd.html), or [`run`](https://www.mathworks.com/help/matlab/ref/run.html) functions to ensure that it is on the path when invoked. For example, to run `myscript.m` in a folder `myfolder` located in the root of the repository, you can specify `command` like this: +When you use this action, all of the required files must be on the MATLAB search path. If your script or function is not in the root of your repository, you can use the [`addpath`](https://www.mathworks.com/help/matlab/ref/addpath.html), [`cd`](https://www.mathworks.com/help/matlab/ref/cd.html), or [`run`](https://www.mathworks.com/help/matlab/ref/run.html) functions to ensure that it is on the path when invoked. For example, to run `myscript.m` in a folder `myfolder` located in the root of the repository, you can specify `command` like this: `command: addpath('myfolder'), myscript` From 4b18b690f27c85aaae1262678ee671c438e0c678 Mon Sep 17 00:00:00 2001 From: Johan Pereira <2079700+jwpereira@users.noreply.github.com> Date: Tue, 18 May 2021 15:43:35 -0400 Subject: [PATCH 4/4] Doc 'install' -> 'set up' but for real this time --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a417ee0..f260f44 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The [Run MATLAB Command](#run-matlab-command) GitHub® action enables you to - To use a self-hosted runner, you must set up a computer with MATLAB (R2013b or later) as your runner. The action uses the topmost MATLAB version on the runner's system path. -- To use a GitHub-hosted runner, you must include the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow to install MATLAB on the runner. Currently, this action is available only for public projects. It does not install transformation products, such as MATLAB Coder™ and MATLAB Compiler™. +- To use a GitHub-hosted runner, you must include the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow to set up MATLAB on the runner. Currently, this action is available only for public projects. It does not set up transformation products, such as MATLAB Coder™ and MATLAB Compiler™. ## Usage Examples Use the **Run MATLAB Command** action to run MATLAB scripts, functions, and statements. You can use this action to flexibly customize your test run or add a MATLAB related step to your workflow. @@ -29,9 +29,9 @@ jobs: ``` ### Run MATLAB Commands on GitHub-Hosted Runner -Before you run MATLAB code or Simulink models on a GitHub-hosted runner, first use the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action. The action installs your specified MATLAB release (R2020a or later) on a Linux® virtual machine. If you do not specify a release, the action installs the latest release of MATLAB. +Before you run MATLAB code or Simulink models on a GitHub-hosted runner, first use the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action. The action sets up your specified MATLAB release (R2020a or later) on a Linux® virtual machine. If you do not specify a release, the action sets up the latest release of MATLAB. -For example, install the latest release of MATLAB on a GitHub-hosted runner, and then use the **Run MATLAB Command** action to execute your MATLAB commands. +For example, set up the latest release of MATLAB on a GitHub-hosted runner, and then use the **Run MATLAB Command** action to execute your MATLAB commands. ```yaml name: Run MATLAB Commands on GitHub-Hosted Runner