Skip to content

Commit

Permalink
replacing project root folder with pwd
Browse files Browse the repository at this point in the history
  • Loading branch information
mw-hrastega authored Feb 16, 2024
1 parent 0569bfb commit 7fcee01
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -56,7 +56,7 @@ Input | Description
`build-options` | <p>(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.<p/><p>**Example:** `build-options: -continueOnFailure`<br/>**Example:** `build-options: -continueOnFailure -skip test`</p>
`startup-options` | <p>(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).<p/><p>Using this input to specify the `-batch` or `-r` option is not supported.<p/><p>**Example:** `startup-options: -nojvm`<br/>**Example:** `startup-options: -nojvm -logfile output.log`</p>

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.
Expand Down

0 comments on commit 7fcee01

Please sign in to comment.