updating README in preparation for matlab-actions/setup-matlab@v2 #88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
replacing v1 with v2
README.md
Outdated
|
|
||
| ### Run MATLAB Build on GitHub-Hosted Runner | ||
| Set up a GitHub-hosted runner to run a specific task and its depended-on tasks that are specified in a file named `buildfile.m` in the root of your repository. To run tasks using the MATLAB build tool, include the [Run MATLAB Build](https://github.com/matlab-actions/run-build/) action in your workflow. This action is supported in MATLAB R2022b and later. | ||
| Use a [GitHub®-hosted runner](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) to run a task and its depended-on tasks that are specified in a file named `buildfile.m` in the root of your repository. Because the `"test"` task in this example runs the tests authored using the MATLAB unit testing framework as well as Simulink Test™, you must set up Simulink and Simulink Test in addition to MATLAB. To run tasks using the MATLAB build tool, include the [Run MATLAB Build](https://github.com/matlab-actions/run-build/) action in your workflow. |
There was a problem hiding this comment.
Should probably link to https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners instead of the self-hosted runner doc
There was a problem hiding this comment.
Thanks for finding this. Fixed it.
mcafaro
reviewed
Feb 5, 2024
README.md
Outdated
| 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® or Windows® virtual machine. If you do not specify a release, the action sets up the latest release of MATLAB. | ||
|
|
||
| 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. Public licensing is not available for transformation products, such as MATLAB Coder™ and MATLAB Compiler™. | ||
| The [Setup MATLAB](#set-up-matlab) action enables you to run MATLAB® code and Simulink® models with a specific version of MATLAB. When you specify this action as part of your workflow, the action sets up your preferred MATLAB release (R2021a or later) on a Linux®, Windows®, or macOS® virtual machine. If you do not specify a release, the action sets up the latest release of MATLAB. As part of the setup process, the action prepends MATLAB to the system PATH environment variable. |
There was a problem hiding this comment.
Not necessarily limited to a virtual machine.
Suggested change
| The [Setup MATLAB](#set-up-matlab) action enables you to run MATLAB® code and Simulink® models with a specific version of MATLAB. When you specify this action as part of your workflow, the action sets up your preferred MATLAB release (R2021a or later) on a Linux®, Windows®, or macOS® virtual machine. If you do not specify a release, the action sets up the latest release of MATLAB. As part of the setup process, the action prepends MATLAB to the system PATH environment variable. | |
| The [Setup MATLAB](#set-up-matlab) action enables you to run MATLAB® code and Simulink® models with a specific version of MATLAB. When you specify this action as part of your workflow, the action sets up your preferred MATLAB release (R2021a or later) on a Linux®, Windows®, or macOS® GitHub runner. If you do not specify a release, the action sets up the latest release of MATLAB. As part of the setup process, the action prepends MATLAB to the system PATH environment variable. |
There was a problem hiding this comment.
Thanks for the flag. Updated this page and the other action markdowns.
README.md
Outdated
| @@ -73,13 +71,38 @@ jobs: | |||
| command: myscript | |||
| ``` | |||
|
|
|||
| ### Run MATLAB Build on Different Platforms | |||
Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com>
mcafaro
approved these changes
Feb 5, 2024
davidbuzinski
approved these changes
Feb 5, 2024
davidbuzinski
added a commit
that referenced
this pull request
Feb 6, 2024
* Invoke installer for private repo support * Disable automatic activation * Fix failing unit test to account for addition call * Add environment variables to workflow * Disable R2020a workflow; only R2020b for now * Build 82c7ee1 * Build for v1.0.1 * Remove -r from BaT workflow * First change * Use mpm * Update action.yml * Update bat.yml * Update install.ts * Add to path * Update index.ts * Pass in products * Add products input * Update bat.yml * Cache installs * Update bat.yml * Update install.ts * Update install.ts * Update install.ts * Update install.ts * Enable caching * Cache in the right place * Print the key * More display tweaks * Get the key right * Cache * merge changes for v2-beta (#50) * v2-beta bugfix (#52) * adding tests to catch bugs * updating unit tests and source code * updating workflow to use 2nd release * fixing update level logic * update level deps script workaround * testing no-op on existing install * add output * Update bat.yml * Update bat.yml * Update bat.yml * Update src/matlab.ts Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> * Update matlab.Release and removed usExisting from destination * updated release info to fix inconsistency * changed output name to matlabroot * fixng pipeline syntax * missing colon in yml * updating naming and fixing missing simulink in bat workflow * changing some variable names for clarity Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> * Update release info (#57) * Restrict supported releases (#65) * Add cache input to leverage Github Actions cache for v2 (#73) * added cache-save and updated build. TODO: cache-restore * added cache restore * fixing release type conversion and bool type conversion * add unit tests * fixing path and cache hit issues * add architecture to cache key and fix description * addressed review feedback * updated MatlabPath state 'type' * updated missed copyrights * changing back latest URL * update cache input description * Fix mpm mac windows v2-beta (#77) * no more unzip mpm * test no windows * update url * try with .exe extension? * fail slow * update url * try cacheFile to fix file location * take out bad secrets * undo bad string interp * trying fix linux mac * use runcommand * use runcommand * try to specify directory * error if no runner temp found * Updated to check if sudo command is available * Add tests * Switch to registry.npmjs.org * Clean up change * Update copyright * Update to check if which returns empty string * merge rc0 changes to mpm branch (#83) * initial commit * npm audit fix * add batch to tc * chmod matlab-batch * rearranging chmod * still wrangling chmod * remove pct * remove PCT from defaults * update tests * cache fix for support packages * make sure support packages path is in cachePaths if defined * add log for supportPackagesPath * capitalize release dir * had wrong default dir * testing windows thing * remove log. use tmpdir for windows * applying mpm fixes for mac & windows * initial commit * npm audit fix * add batch to tc * chmod matlab-batch * rearranging chmod * still wrangling chmod * remove pct * remove PCT from defaults * update tests * cache fix for support packages * make sure support packages path is in cachePaths if defined * add log for supportPackagesPath * capitalize release dir * had wrong default dir * testing windows thing * remove log. use tmpdir for windows * applying mpm fixes for mac & windows * Merge windows optimization to v2-rc0 * improve os specific cache dir implemenation * try to link after install * symlink wrong direction? * update toolcache impl * forgot .keep * forgot dist * fix typo * debug * more debug idk * forgot recursive * seeing whatever is going on with .complete file * add tests for windows toolcache optimization * prep for merge * one more update before merge * Update bat.yml to v2-rc0 for build until release * address sam's feedback * address mark's feedback * fix error message * switch statement sugar Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> * Accept any number of spaces in product list Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> --------- Co-authored-by: sameagen <sameagen@mathworks.com> Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> * Update action node version (#84) * init update * update bat.yml * update bat.yml * review comments * updating README in preparation for matlab-actions/setup-matlab@v2 (#88) * Update README.md replacing v1 with v2 * removing text on platform restrictions * replacing a verb * updating the action description * replacing 20b with 21a * updating products description * updating the cache description * adding a placeholder section * adding missing trademark symbol * update the first example description * removing a code block * updating the last example description * addressing review feedback * Fix a typo. Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> --------- Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> --------- Co-authored-by: Johan Pereira <2079700+jwpereira@users.noreply.github.com> Co-authored-by: Andy Campbell <acampbel@mathworks.com> Co-authored-by: Mark Cafaro <34887852+mcafaro@users.noreply.github.com> Co-authored-by: sameagen <sameagen@mathworks.com> Co-authored-by: sameagen-MW <122639681+sameagen-MW@users.noreply.github.com> Co-authored-by: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.