You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| `release` | <p>(Optional) MATLAB release to set up. You can specify R2021a or a later release. By default, the value of `release` is `latest`, which corresponds to the latest release of MATLAB.</p><p><ul><li>To set up the latest update of a release, specify only the release name, for example, `R2024a`.</li><li>To set up a specific update release, specify the release name with an update number suffix, for example, `R2024aU4`.</li><li>To set up a release without updates, specify the release name with an update 0 or general release suffix, for example, `R2024aU0` or `R2024aGR`.</li></ul></p><p>**Example**: `release: R2024a`<br/>**Example**: `release: latest`<br/>**Example**: `release: R2024aU4`</p> |
144
144
| `products` | <p>(Optional) Products to set up in addition to MATLAB, specified as a list of product names separated by spaces. You can specify `products` to set up most MathWorks products and support packages. The action uses [MATLAB Package Manager](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md) (`mpm`) to set up products.</p><p>For a list of supported products, open the input file for your preferred release from the [`mpm-input-files`](https://github.com/mathworks-ref-arch/matlab-dockerfile/tree/main/mpm-input-files) folder on GitHub. Specify products using the format shown in the input file, excluding the `#product.` prefix. For example, to set up Deep Learning Toolbox™ in addition to MATLAB, specify `products: Deep_Learning_Toolbox`.</p><p>For an example of how to use the `products` input, see [Run Tests in Parallel](#run-tests-in-parallel).</p><p>**Example**: `products: Simulink`<br/>**Example:** `products: Simulink Deep_Learning_Toolbox`</p> |
145
+
| `install-system-dependencies` | <p>(Optional) Option to control system dependency installation, specified as `"auto"`, `"true"`, or `"false"`. By default, the value is `"auto"`, which installs system dependencies on GitHub-hosted runners and skips installation on self-hosted runners. Set to `"true"` to force installation regardless of runner type, or `"false"` to skip installation regardless of runner type.</p><p>**Note**: On a self-hosted runner, specifying a value of `"true"` requires that the runner be configured with passwordless sudo access.</p><p>**Example**: `install-system-dependencies: true`</p> |
145
146
| `cache` | <p>(Optional) Option to enable caching with GitHub Actions, specified as `false` or `true`. By default, the value is `false` and the action does not store MATLAB and the specified products in a GitHub Actions cache for future use. For more information about caching with GitHub Actions, see [Caching dependencies to speed up workflows](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows).</p><p>**Example**: `cache: true`</p> |
146
-
| `install-system-dependencies` | <p>(Optional) Option to control system dependency installation, specified as `"auto"`, `"true"`, or `"false"`. By default, the value is `"auto"`, which installs system dependencies on GitHub-hosted runners and skips installation on self-hosted runners. Set to `"true"` to force installation regardless of runner type, or `"false"` to skip installation regardless of runner type.</p><p>**Note**: When using `"true"` on self-hosted runners, the runner must have passwordless sudo access configured.</p><p>**Example**: `install-system-dependencies: true`</p> |
147
+
147
148
148
149
#### Required Software on Self-Hosted Runners
149
150
150
151
Before using the **Setup MATLAB** action to set up MATLAB and other MathWorks products on a self-hosted UNIX runner, verify that the required software is installed on your runner.
151
152
152
153
##### Linux
153
154
154
-
If you are using a Linux runner, verify that the following software is installed on your runner:
155
+
If you are using a Linux runner, the following software must be installed on the runner:
155
156
156
157
- Third-party packages required to run the `mpm` command — To view the list of `mpm` dependencies, refer to the Linux section of [Get MATLAB Package Manager](https://www.mathworks.com/help/install/ug/get-mpm-os-command-line.html).
157
158
- All MATLAB dependencies — To view the list of MATLAB dependencies, go to the [MATLAB Dependencies](https://github.com/mathworks-ref-arch/container-images/tree/main/matlab-deps) repository on GitHub. Then, open the `<release>/<system>/base-dependencies.txt` file for your MATLAB release and your runner's operating system.
158
159
159
160
##### macOS
160
161
161
-
If you are using a macOS runner with an Apple silicon processor, verify that Java® Runtime Environment (JRE™) is installed on your runner. For information about this requirement and to get a compatible JRE version, see [MATLAB on Apple Silicon Macs](https://www.mathworks.com/support/requirements/apple-silicon.html).
162
+
If you are using a macOS runner with an Apple silicon processor, Java® Runtime Environment (JRE™) must be installed on the runner. For information about this requirement and to get a compatible JRE version, see [MATLAB on Apple Silicon Macs](https://www.mathworks.com/support/requirements/apple-silicon.html).
162
163
163
-
> **Tip:** One convenient way to include the required dependencies on a self-hosted runner is to specify the [MATLAB Dependencies container image on Docker® Hub](https://hub.docker.com/r/mathworks/matlab-deps) in your workflow.
164
+
> **Tip:** If you are using a container on your self-hosted runner, you can install the required dependencies in the container by specifying the [MATLAB Dependencies container image on Docker® Hub](https://hub.docker.com/r/mathworks/matlab-deps) in your workflow.
0 commit comments