Update README for Run MATLAB Command #3
Conversation
jwpereira
left a comment
jwpereira
left a comment
There was a problem hiding this comment.
Now this.. is a real doc 😁
Thanks, @mw-hrastega! 😄
README.md
Outdated
| ``` | ||
| ## Run MATLAB Command | ||
| When you define your workflow in the `.github/workflows` directory of your repositoy, you can specify the **Run MATLAB Command** action using the `run-command` key. The action requires an input. |
There was a problem hiding this comment.
| When you define your workflow in the `.github/workflows` directory of your repositoy, you can specify the **Run MATLAB Command** action using the `run-command` key. The action requires an input. | |
| When you define your workflow in the `.github/workflows` directory of your repository, you can specify the **Run MATLAB Command** action using the `run-command` key. The action requires an input. |
README.md
Outdated
| ``` | ||
| ## Run MATLAB Command | ||
| When you define your workflow in the `.github/workflows` directory of your repositoy, you can specify the **Run MATLAB Command** action using the `run-command` key. The action requires an input. |
There was a problem hiding this comment.
In practice, I don't think users will be able to call run-command without qualifying it with our org and a version 🤔
They'd have to use matlab-actions/run-command@v0 🤔
There was a problem hiding this comment.
How about the updated version?
README.md
Outdated
| [`error`](https://www.mathworks.com/help/matlab/ref/assert.html) functions in | ||
| the command to ensure that builds fail when necessary. When you use this task, | ||
| all of the required files must be on the MATLAB search path. | ||
| - If you want to use a self-hosted runner, you must set up a computer with MATLAB (R2013b or later) as your runner. The action uses the first MATLAB version on the runner's path. |
There was a problem hiding this comment.
"The action uses the first MATLAB version on the runner's system path."
README.md
Outdated
| - name: Run script | ||
| uses: matlab-actions/run-command@v0 | ||
| with: | ||
| command: 'myscript' |
There was a problem hiding this comment.
We may want to consider not showing the command wrapped in single quotes. I believe these quotes are generally unneeded and a user may want to use single quotes in their actual MATLAB command, in which case they would need to learn how to properly escape them.
README.md
Outdated
| uses: matlab-actions/run-command@v0 | ||
| with: | ||
| command: disp('hello world') | ||
| command: 'results = runtests, assertSuccess(results);' |
There was a problem hiding this comment.
Again, perhaps lose the quotes.
README.md
Outdated
|
|
||
| Input | Description | ||
| ------------------------- | --------------- | ||
| `command` | (Required) Script, function, or statement to execute. If the value of `command` is the name of a MATLAB script or function, do not specify the file extension. If you specify more than one MATLAB command, use a comma or semicolon to separate the commands.<br/>**Example:** `'myscript'`<br/>**Example:** `'results = runtests, assertSuccess(results);'` |
Updated the text and examples. When reviewing the examples, please pay attention to the text in the YAML scripts.