From 4001148c7c0b4d50ed65e3475a8d0ec7040d99ab Mon Sep 17 00:00:00 2001 From: David Buzinski <103441853+davidbuzinski@users.noreply.github.com> Date: Thu, 8 Feb 2024 10:06:08 -0500 Subject: [PATCH] v1 doc (#65) --- src/commands/install.yml | 18 +++++++++++------- src/examples/run-build.yml | 2 +- src/examples/run-custom-script.yml | 2 +- src/examples/run-tests-with-report.yml | 6 ++++-- 4 files changed, 17 insertions(+), 11 deletions(-) diff --git a/src/commands/install.yml b/src/commands/install.yml index dc4a435..ca50e92 100644 --- a/src/commands/install.yml +++ b/src/commands/install.yml @@ -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 diff --git a/src/examples/run-build.yml b/src/examples/run-build.yml index 0c3d828..9f324ff 100644 --- a/src/examples/run-build.yml +++ b/src/examples/run-build.yml @@ -4,7 +4,7 @@ description: > usage: version: 2.1 orbs: - matlab: mathworks/matlab@0 + matlab: mathworks/matlab@1 jobs: build: machine: diff --git a/src/examples/run-custom-script.yml b/src/examples/run-custom-script.yml index f6975bd..9503719 100644 --- a/src/examples/run-custom-script.yml +++ b/src/examples/run-custom-script.yml @@ -4,7 +4,7 @@ description: > usage: version: 2.1 orbs: - matlab: mathworks/matlab@0 + matlab: mathworks/matlab@1 jobs: build: machine: diff --git a/src/examples/run-tests-with-report.yml b/src/examples/run-tests-with-report.yml index 14a7ad0..ee0cc8c 100644 --- a/src/examples/run-tests-with-report.yml +++ b/src/examples/run-tests-with-report.yml @@ -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: