You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ The **Run MATLAB Tests** action accepts optional inputs. For example, you can ad
129
129
| `test-results-simulink-test` | <p>(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.</p><p>**Example:** `test-results-simulink-test: test-results/results.mldatx`</p> |
130
130
| `code-coverage-html` | <p>(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. </p><p>**Example:** `code-coverage-html: code-coverage`</p> |
131
131
| `code-coverage-cobertura` | <p>(Optional) Location to write the code coverage results in Cobertura XML format, specified as a file path relative to the project root folder.</p><p>**Example:** `code-coverage-cobertura: code-coverage/coverage.xml`</p> |
132
-
| `code-coverage-metric-level` | <p>(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).</p><p>For the action to include coverage metrics in the GitHub job summary, the following requirements must be met:<ul><li>MATLAB Test™ must be installed and licensed on the runner.</li><li>You must not specify the `code-coverage-html` or `code-coverage-cobertura` inputs. If you specify either input, the action writes the code coverage results to the specified location but does not include coverage metrics in the GitHub job summary.</li></ul></p><p>**Example:** `code-coverage-metric-level: statement`</p> |
132
+
| `code-coverage-metric-level` | <p>(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).</p><p>For the action to include coverage metrics in the GitHub job summary, the following requirements must be met:<ul><li>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.</li><li>You must not specify the `code-coverage-html` or `code-coverage-cobertura` inputs. If you specify either input, the action writes the code coverage results to the specified location but does not include coverage metrics in the GitHub job summary.</li></ul></p><p>**Example:** `code-coverage-metric-level: statement`</p> |
133
133
| `model-coverage-html` | <p>(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.</p><p>**Example:** `model-coverage-html: model-coverage`</p> |
134
134
| `model-coverage-cobertura` | <p>(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.</p><p>**Example:** `model-coverage-cobertura: model-coverage/coverage.xml`</p> |
135
135
| `generate-summary` | <p>(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.</p><p>For more information about test and coverage summaries, see [View Test and Coverage Results](#view-test-and-coverage-results).</p><p>**Example:** `generate-summary: false`</p> |
@@ -157,7 +157,7 @@ You can interact with the **All tests** table using the expanders to the left of
157
157
158
158
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:
159
159
160
-
- MATLAB Test must be installed and licensed on the runner.
160
+
- 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.
161
161
- You must not specify the `code-coverage-html` or `code-coverage-cobertura` action inputs.
162
162
163
163
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.
0 commit comments