diff --git a/README.md b/README.md index 551f1c8..912b258 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Starting in R2022b, the MATLAB® build tool provides a standard programming i The [Run MATLAB Build](#run-matlab-build) action enables you to invoke the MATLAB build tool on a self-hosted or GitHub®-hosted runner. The action uses the topmost MATLAB version on the system path. ## Examples -Use the **Run MATLAB Build** action to run a build using the MATLAB build tool. You can use this action to run the tasks specified in a file named `buildfile.m` in the root of your repository. To use the **Run MATLAB Build** action, you need MATLAB R2022b or a later release. +Use the **Run MATLAB Build** action to run a build using the MATLAB build tool. You can use this action to run the tasks specified in a file named `buildfile.m` in the MATLAB current folder or its parent folders. To use the **Run MATLAB Build** action, you need MATLAB R2022b or a later release. ### Run MATLAB Build on Self-Hosted Runner Use a [self-hosted runner](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) to run the default tasks in your build plan as well as all the tasks on which they depend. @@ -56,7 +56,7 @@ Input | Description `build-options` |

(Optional) MATLAB build options, specified as a list of options separated by spaces. The action supports the same [options](https://www.mathworks.com/help/matlab/ref/buildtool.html#mw_50c0f35e-93df-4579-963d-f59f2fba1dba) that you can pass to the `buildtool` command when running a MATLAB build.

**Example:** `build-options: -continueOnFailure`
**Example:** `build-options: -continueOnFailure -skip test`

`startup-options` |

(Optional) MATLAB startup options, specified as a list of options separated by spaces. For more information about startup options, see [Commonly Used Startup Options](https://www.mathworks.com/help/matlab/matlab_env/commonly-used-startup-options.html).

Using this input to specify the `-batch` or `-r` option is not supported.

**Example:** `startup-options: -nojvm`
**Example:** `startup-options: -nojvm -logfile output.log`

-When you use this action, a file named `buildfile.m` must be in the project root directory. +When you use this action, a file named `buildfile.m` must be in the MATLAB current folder or its parent folders. ## Notes * The **Run MATLAB Build** action uses the `-batch` option to invoke the [`buildtool`](https://www.mathworks.com/help/matlab/ref/buildtool.html) command. Preferences do not persist across different MATLAB sessions launched with the `-batch` option. To run code that requires the same preferences, use a single action.