Skip to content

Commit

Permalink
v1 doc (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbuzinski authored Feb 8, 2024
1 parent 4e33743 commit 4001148
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 11 deletions.
18 changes: 11 additions & 7 deletions src/commands/install.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
description: >
Install MATLAB on a Linux machine executor. Currently, this command is available only for public
projects and does not include transformation products, such as MATLAB Coder and MATLAB Compiler.
Install a specific version of MATLAB. (If you use this command to install transformation products,
such as MATLAB Coder and MATLAB Compiler, the command does not automatically license such products for you.)
parameters:
products:
description: >
List of MathWorks products to install.
Products to install in addition to MATLAB, specified as a list of product names separated by
spaces. You can specify this parameter to install most MathWorks products and support packages. The
command uses MATLAB Package Manager (`mpm`) to install products. For a list of supported
products and their correctly formatted names, see
https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md#product-installation-options.
type: string
default: 'MATLAB'
default: ''
release:
description: >
MATLAB release to install. You can specify R2020a or a later release. By default, the command
installs the latest release of MATLAB.
MATLAB release to install. You can specify R2021a or a later release. By default, the value of `release`
is `latest`. If you do not specify `release`, the command installs the latest release of MATLAB.
type: string
default: 'latest'
no-output-timeout:
description: >
Elapsed time the tests can run without output. The string is a decimal with unit suffix,
Elapsed time the command can run without output. The string is a decimal with unit suffix,
such as “20m”, “1.25h”, “5s”. The default is 10 minutes and the maximum is governed by the
maximum time a job is allowed to run.
type: string
Expand Down
2 changes: 1 addition & 1 deletion src/examples/run-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
usage:
version: 2.1
orbs:
matlab: mathworks/matlab@0
matlab: mathworks/matlab@1
jobs:
build:
machine:
Expand Down
2 changes: 1 addition & 1 deletion src/examples/run-custom-script.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
usage:
version: 2.1
orbs:
matlab: mathworks/matlab@0
matlab: mathworks/matlab@1
jobs:
build:
machine:
Expand Down
6 changes: 4 additions & 2 deletions src/examples/run-tests-with-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ description: >
usage:
version: 2.1
orbs:
matlab: mathworks/matlab@0
matlab: mathworks/matlab@1
jobs:
build:
machine:
image: ubuntu-2204:2022.07.1
steps:
- checkout
- matlab/install
# Install Simulink and Simulink Test in addition to MATLAB
- matlab/install:
products: Simulink Simulink_Test
- matlab/run-tests:
test-results-junit: test-results/matlab/results.xml
- store_test_results:
Expand Down

0 comments on commit 4001148

Please sign in to comment.