From 735107d7d7c6c0529c0a80e4a11abbac68760a0b Mon Sep 17 00:00:00 2001 From: mw-hrastega <48831250+mw-hrastega@users.noreply.github.com> Date: Mon, 13 Oct 2025 11:35:17 -0400 Subject: [PATCH] Document the `selectByName` input --- overview.md | 1 + 1 file changed, 1 insertion(+) diff --git a/overview.md b/overview.md index 44ea4f32..c98f9955 100644 --- a/overview.md +++ b/overview.md @@ -228,6 +228,7 @@ Input | Description ------------------------- | --------------- `sourceFolder` |
(Optional) Location of the folder containing source code, specified as a path relative to the project root folder. The specified folder and its subfolders are added to the top of the MATLAB search path. If you specify `sourceFolder` and then generate a coverage report, the task uses only the source code in the specified folder and its subfolders to generate the report. You can specify multiple folders using a colon-separated or semicolon-separated list.
**Example:** `sourceFolder: source`
**Example:** `sourceFolder: source/folderA; source/folderB`
(Optional) Location of the folder used to select test suite elements, specified as a path relative to the project root folder. To create a test suite, the task uses only the tests in the specified folder and its subfolders. You can specify multiple folders using a colon-separated or semicolon-separated list.
**Example:** `selectByFolder: test`
**Example:** `selectByFolder: test/folderA; test/folderB`
(Optional) Names of the tests to run, specified as a list of test names separated by spaces. If you specify this input, the task runs only the tests with the specified names. You can use the wildcard character (`*`) to match any number of characters and the question mark character (`?`) to match a single character. For example, specify `selectByName: ExampleTest/*` to select all the tests whose name starts with `ExampleTest/`.
For a given test file, the name of a test uniquely identifies the smallest runnable portion of the test content. The test name includes the namespace name, filename (excluding the extension), procedure name, and information about parameterization.
**Example:** `selectByName: ExampleTest/testA`
**Example:** `selectByName: ExampleTest/testA ExampleTest/testB(array=3x3_double)`
(Optional) Test tag used to select test suite elements. To create a test suite, the task uses only the test elements with the specified tag.
**Example:** `selectByTag: Unit`
`strict` |(Optional) Option to apply strict checks when running tests, specified as `false` or `true`. By default, the value is `false`. If you specify a value of `true`, the task generates a qualification failure whenever a test issues a warning.
**Example:** `strict: true`
`useParallel` |(Optional) Option to run tests in parallel, specified as `false` or `true`. By default, the value is `false` and tests run in serial. If the test runner configuration is suited for parallelization, you can specify a value of `true` to run tests in parallel. This input requires a Parallel Computing Toolbox license.
**Example:** `useParallel: true`