Skip to content

Commit 0e53156

Browse files
authored
Merge pull request #16 from matlab-actions/jpereira/market
Doc adjustments for v1
2 parents 5a46c7b + d5bef8d commit 0e53156

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Action for Installing MATLAB on GitHub-Hosted Runner
1+
# Action for Setting Up MATLAB on GitHub-Hosted Runner
22

3-
Before you run MATLAB® code and Simulink® models on a [GitHub®-hosted](https://docs.github.com/en/free-pro-team@latest/actions/reference/specifications-for-github-hosted-runners) runner, first use the [Set Up MATLAB](#set-up-matlab) action. The action installs the specified MATLAB release on a Linux® virtual machine. If you do not specify a release, the action installs the latest release of MATLAB.
3+
Before you run MATLAB® code and Simulink® models on a [GitHub®-hosted](https://docs.github.com/en/free-pro-team@latest/actions/reference/specifications-for-github-hosted-runners) runner, first use the [Setup MATLAB](#set-up-matlab) action. The action sets up the specified MATLAB release on a Linux® virtual machine. If you do not specify a release, the action sets up the latest release of MATLAB.
44

5-
The **Set Up MATLAB** action is not supported on [self-hosted](https://docs.github.com/en/free-pro-team@latest/actions/hosting-your-own-runners/about-self-hosted-runners) runners. Currently, it is available only for public projects. It does not install transformation products, such as MATLAB Coder™ and MATLAB Compiler™.
5+
The **Setup MATLAB** action is not supported on [self-hosted](https://docs.github.com/en/free-pro-team@latest/actions/hosting-your-own-runners/about-self-hosted-runners) runners. Currently, it is available only for public projects. It does not set up transformation products, such as MATLAB Coder™ and MATLAB Compiler™.
66

77
## Usage Examples
8-
Once you install MATLAB, you can use the runner to execute MATLAB scripts, functions, or statements. You also can use the runner to execute MATLAB and Simulink tests and generate artifacts. To execute code on the runner, include the [Run MATLAB Command](https://github.com/matlab-actions/run-command/) or [Run MATLAB Tests](https://github.com/matlab-actions/run-tests/) actions in your workflow.
8+
Once you set up MATLAB, you can use the runner to execute MATLAB scripts, functions, or statements. You also can use the runner to execute MATLAB and Simulink tests and generate artifacts. To execute code on the runner, include the [Run MATLAB Command](https://github.com/matlab-actions/run-command/) or [Run MATLAB Tests](https://github.com/matlab-actions/run-tests/) actions in your workflow.
99

1010
### Run MATLAB Script on GitHub-Hosted Runner
1111
Set up a GitHub-hosted runner to run the commands in a file named `myscript.m` in the root of your repository. To run the script, include the [Run MATLAB Command](https://github.com/matlab-actions/run-command/) action in your workflow.
@@ -20,10 +20,10 @@ jobs:
2020
steps:
2121
- name: Check out repository
2222
uses: actions/checkout@v2
23-
- name: Install MATLAB
24-
uses: matlab-actions/setup-matlab@v0
23+
- name: Set up MATLAB
24+
uses: matlab-actions/setup-matlab@v1
2525
- name: Run script
26-
uses: matlab-actions/run-command@v0
26+
uses: matlab-actions/run-command@v1
2727
with:
2828
command: myscript
2929
```
@@ -41,24 +41,24 @@ jobs:
4141
steps:
4242
- name: Check out repository
4343
uses: actions/checkout@v2
44-
- name: Install MATLAB
45-
uses: matlab-actions/setup-matlab@v0
44+
- name: Set up MATLAB
45+
uses: matlab-actions/setup-matlab@v1
4646
- name: Run tests and generate artifacts
47-
uses: matlab-actions/run-tests@v0
47+
uses: matlab-actions/run-tests@v1
4848
with:
4949
test-results-junit: test-results/results.xml
5050
code-coverage-cobertura: code-coverage/coverage.xml
5151
```
5252
5353
## Set Up MATLAB
54-
When you define your workflow in the `.github/workflows` directory of your repository, specify the **Set Up MATLAB** action as `matlab-actions/setup-matlab@v0`. The action accepts an optional input.
54+
When you define your workflow in the `.github/workflows` directory of your repository, specify the **Setup MATLAB** action as `matlab-actions/setup-matlab@v1`. The action accepts an optional input.
5555

5656
| Input | Description |
5757
|-----------|-------------|
58-
| `release` | (Optional) MATLAB release to install. You can specify R2020a or a later release. If you do not specify `release`, the action installs the latest release of MATLAB.<br/>**Example**: `R2020a`
58+
| `release` | (Optional) MATLAB release to set up. You can specify R2020a or a later release. If you do not specify `release`, the action sets up the latest release of MATLAB.<br/>**Example**: `R2021a`
5959

6060
## Notes
61-
When you use the **Set Up MATLAB** action, you execute third-party code that is licensed under separate terms.
61+
When you use the **Setup MATLAB** action, you execute third-party code that is licensed under separate terms.
6262

6363
## See Also
6464
- [Action for Running MATLAB Commands](https://github.com/matlab-actions/run-command/)

0 commit comments

Comments
 (0)