diff --git a/README.md b/README.md index e963cef..e9a3458 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ The **Run MATLAB Tests** action accepts optional inputs. For example, you can ad | `test-results-simulink-test` |
(Optional) Location to export Simulink Test Manager results in MLDATX format, specified as a file path relative to the project root folder. This input requires a Simulink Test license and is supported in MATLAB R2019a and later.
**Example:** `test-results-simulink-test: test-results/results.mldatx`
| | `code-coverage-html` |(Optional) Location to write the code coverage results in HTML format, specified as a folder path relative to the project root folder. The results include statement and function coverage metrics.
**Example:** `code-coverage-html: code-coverage`
| | `code-coverage-cobertura` |(Optional) Location to write the code coverage results in Cobertura XML format, specified as a file path relative to the project root folder.
**Example:** `code-coverage-cobertura: code-coverage/coverage.xml`
| -| `code-coverage-metric-level` |(Optional) Level of code coverage metrics to include in the GitHub job summary, specified as `statement`, `decision`, `condition`, or `mcdc`. By default, the action uses the highest level (`mcdc`) when generating the coverage summary, which results in a table that includes the function, statement, decision, condition, and modified condition/decision coverage (MC/DC) metrics. Use this input to include metrics up to and including a specific level, instead of the highest possible level. For example, to include only function and statement coverage metrics, specify `code-coverage-metric-level` as `statement`. For more information about coverage metric levels, see [Types of Code Coverage for MATLAB Source Code](https://www.mathworks.com/help/matlab-test/ug/types-of-code-coverage-for-matlab-source-code.html).
For the action to include coverage metrics in the GitHub job summary, the following requirements must be met:
**Example:** `code-coverage-metric-level: statement`
| +| `code-coverage-metric-level` |(Optional) Level of code coverage metrics to include in the GitHub job summary, specified as `statement`, `decision`, `condition`, or `mcdc`. By default, the action uses the highest level (`mcdc`) when generating the coverage summary, which results in a table that includes the function, statement, decision, condition, and modified condition/decision coverage (MC/DC) metrics. Use this input to include metrics up to and including a specific level, instead of the highest possible level. For example, to include only function and statement coverage metrics, specify `code-coverage-metric-level` as `statement`. For more information about coverage metric levels, see [Types of Code Coverage for MATLAB Source Code](https://www.mathworks.com/help/matlab-test/ug/types-of-code-coverage-for-matlab-source-code.html).
For the action to include coverage metrics in the GitHub job summary, the following requirements must be met:
**Example:** `code-coverage-metric-level: statement`
| | `model-coverage-html` |(Optional) Location to write the model coverage results in HTML format, specified as a folder path relative to the project root folder. This input requires a Simulink Coverage™ license and is supported in MATLAB R2018b and later.
**Example:** `model-coverage-html: model-coverage`
| | `model-coverage-cobertura` |(Optional) Location to write the model coverage results in Cobertura XML format, specified as a file path relative to the project root folder. This input requires a Simulink Coverage license and is supported in MATLAB R2018b and later.
**Example:** `model-coverage-cobertura: model-coverage/coverage.xml`
| | `generate-summary` |(Optional) Option to generate summaries of test and coverage results in the GitHub job summary, specified as `true` or `false`. By default, the value is `true`. If you specify a value of `false`, the action does not generate test and coverage summaries in the GitHub job summary. Generating test and coverage summaries requires a MATLAB Test license.
For more information about test and coverage summaries, see [View Test and Coverage Results](#view-test-and-coverage-results).
**Example:** `generate-summary: false`
| @@ -157,7 +157,7 @@ You can interact with the **All tests** table using the expanders to the left of The **MATLAB Code Coverage** table in the GitHub job summary displays the collected code coverage metrics for the MATLAB source code specified by the `source-folder` input of the **Run MATLAB Tests** action. For the action to generate this table, the following requirements must be met: -- MATLAB Test must be installed and licensed on the runner. +- You must have a MATLAB Test license. To collect decision coverage, condition coverage, and MC/DC metrics, you must also install MATLAB Test on the runner. - You must not specify the `code-coverage-html` or `code-coverage-cobertura` action inputs. By default, the table includes the function, statement, decision, condition, and modified condition/decision coverage (MC/DC) metrics. To limit the level of coverage metrics displayed, use the `code-coverage-metric-level` action input.