Skip to content

Commit 5093c86

Browse files
committed
Update readme
1 parent 3dab4ec commit 5093c86

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

Readme.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,24 @@ jobs:
6666
run: dotnet test --configuration Release --logger GitHubActions
6767
```
6868
69+
By default, the logger will only report failed tests in the job summary and annotations.
70+
If you want the summary to include detailed information about passed and skipped tests as well, update the workflow as follows:
71+
72+
```yaml
73+
jobs:
74+
build:
75+
runs-on: ubuntu-latest
76+
77+
steps:
78+
# ...
79+
80+
- name: Build & test
81+
run: >
82+
dotnet test
83+
--configuration Release
84+
--logger "GitHubActions;summary.includePassedTests=true;summary.includeSkippedTests=true"
85+
```
86+
6987
> **Important**:
7088
> Ensure that your test project references the latest version of **Microsoft.NET.Test.Sdk**.
7189
> Older versions of this package may not be compatible with the logger.
@@ -165,9 +183,15 @@ If you want to link passed tests to their corresponding source definitions, make
165183

166184
**Default**: `false`.
167185

186+
> **Warning**:
187+
> If your test suite is really large, enabling this option may cause the summary to exceed the [maximum allowed size](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#step-isolation-and-limits).
188+
168189
#### Include skipped tests in summary
169190

170191
Use the `summary.includeSkippedTests` option to specify whether skipped tests should be included in the summary.
171192
If you want to link skipped tests to their corresponding source definitions, make sure to also enable [source information collection](#collecting-source-information).
172193

173-
**Default**: `false`.
194+
**Default**: `false`.
195+
196+
> **Warning**:
197+
> If your test suite is really large, enabling this option may cause the summary to exceed the [maximum allowed size](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#step-isolation-and-limits).

0 commit comments

Comments
 (0)