Skip to content

Commit d1c56cf

Browse files
committed
README updates
1 parent 5e4566e commit d1c56cf

File tree

1 file changed

+24
-43
lines changed

1 file changed

+24
-43
lines changed

README.md

Lines changed: 24 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ Options:
6868
--include Filter expressions to include specific modules and types.
6969
--exclude-by-file Glob patterns specifying source files to exclude.
7070
--merge-with Path to existing coverage result to merge.
71-
--teamcity-output Output coverage results to console using TeamCity service messages.
7271
```
7372
7473
#### Code Coverage
@@ -99,6 +98,7 @@ Supported Formats:
9998
* lcov
10099
* opencover
101100
* cobertura
101+
* teamcity
102102
103103
The `--format` option can be specified multiple times to output multiple formats in a single run:
104104
@@ -118,6 +118,28 @@ The above command will write the results to the supplied path, if no file extens
118118
coverlet <ASSEMBLY> --target <TARGET> --targetargs <TARGETARGS> --output "/custom/directory/" -f json -f lcov
119119
```
120120
121+
#### TeamCity Output
122+
123+
Coverlet can output basic code coverage statistics using [TeamCity service messages](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages).
124+
125+
```bash
126+
coverlet <ASSEMBLY> --target <TARGET> --targetargs <TARGETARGS> --output teamcity
127+
```
128+
129+
The currently supported [TeamCity statistics](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages) are:
130+
131+
| TeamCity Statistic Key | Description |
132+
| :--- | :--- |
133+
| CodeCoverageL | Line-level code coverage |
134+
| CodeCoverageC | Class-level code coverage |
135+
| CodeCoverageM | Method-level code coverage |
136+
| CodeCoverageAbsLTotal | The total number of lines |
137+
| CodeCoverageAbsLCovered | The number of covered lines |
138+
| CodeCoverageAbsCTotal | The total number of classes |
139+
| CodeCoverageAbsCCovered | The number of covered classes |
140+
| CodeCoverageAbsMTotal | The total number of methods |
141+
| CodeCoverageAbsMCovered | The number of covered methods |
142+
121143
#### Merging Results
122144
123145
With Coverlet you can combine the output of multiple coverage runs into a single result.
@@ -195,27 +217,6 @@ Examples
195217
196218
Both `--exclude` and `--include` options can be used together but `--exclude` takes precedence. You can specify the `--exclude` and `--include` options multiple times to allow for multiple filter expressions.
197219
198-
#### TeamCity Output
199-
200-
Coverlet can output basic code coverage statistics using [TeamCity service messages](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages).
201-
202-
```bash
203-
coverlet <ASSEMBLY> --target <TARGET> --targetargs <TARGETARGS> --teamcity-output
204-
```
205-
206-
The currently supported [TeamCity statistics](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages) are:
207-
| TeamCity Statistic Key | Description |
208-
| :--- | :--- |
209-
| CodeCoverageL | Line-level code coverage |
210-
| CodeCoverageC | Class-level code coverage |
211-
| CodeCoverageM | Method-level code coverage |
212-
| CodeCoverageAbsLTotal | The total number of lines |
213-
| CodeCoverageAbsLCovered | The number of covered lines |
214-
| CodeCoverageAbsCTotal | The total number of classes |
215-
| CodeCoverageAbsCCovered | The number of covered classes |
216-
| CodeCoverageAbsMTotal | The total number of methods |
217-
| CodeCoverageAbsMCovered | The number of covered methods |
218-
219220
### MSBuild
220221
221222
In this mode, Coverlet doesn't require any additional setup other than including the NuGet package in the unit test project. It integrates with the `dotnet test` infrastructure built into the .NET Core CLI and when enabled, will automatically generate coverage results after tests are run.
@@ -256,6 +257,7 @@ Supported Formats:
256257
* lcov
257258
* opencover
258259
* cobertura
260+
* teamcity
259261
260262
You can specify multiple output formats by separating them with a comma (`,`).
261263
@@ -297,27 +299,6 @@ dotnet test /p:CollectCoverage=true /p:Threshold=80 /p:ThresholdType=line
297299
298300
You can specify multiple values for `ThresholdType` by separating them with commas. Valid values include `line`, `branch` and `method`.
299301
300-
#### TeamCity Output
301-
302-
Coverlet can output basic code coverage statistics using [TeamCity service messages](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages).
303-
304-
```bash
305-
dotnet test /p:CollectCoverage=true /p:TeamCityOutput=true
306-
```
307-
308-
The currently supported [TeamCity statistics](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages) are:
309-
| TeamCity Statistic Key | Description |
310-
| :--- | :--- |
311-
| CodeCoverageL | Line-level code coverage |
312-
| CodeCoverageC | Class-level code coverage |
313-
| CodeCoverageM | Method-level code coverage |
314-
| CodeCoverageAbsLTotal | The total number of lines |
315-
| CodeCoverageAbsLCovered | The number of covered lines |
316-
| CodeCoverageAbsCTotal | The total number of classes |
317-
| CodeCoverageAbsCCovered | The number of covered classes |
318-
| CodeCoverageAbsMTotal | The total number of methods |
319-
| CodeCoverageAbsMCovered | The number of covered methods |
320-
321302
#### Excluding From Coverage
322303
323304
##### Attributes

0 commit comments

Comments
 (0)