DotCov.Fallout 3.0.0

DotCov.Fallout

Coverage reporting and threshold gating for Fallout builds — one interface, no target wiring.

Migrating from DotCov.Nuke

Version 1.0 replaces DotCov.Nuke with this package; it is not a NUKE compatibility shim. First migrate your build with the Fallout migration guide, then replace the DotCov.Nuke package reference with DotCov.Fallout version 1.0.0 and change using DotCov.Nuke; to using DotCov.Fallout;. Keep ICoverageReport on your FalloutBuild. Existing DotCov.Nuke 0.x packages remain separate and do not automatically redirect to this package.

See the 1.0 migration notes for the accompanying parser API changes.

Getting started

fallout :add-package DotCov.Fallout

using DotCov.Fallout;

class Build : FalloutBuild, ICoverageReport { }

fallout ReportCoverage --coverage-min-line 80 --coverage-exclude-generated-param true

That is the whole setup. There is no default threshold: set --coverage-min-line, --coverage-min-branch, or both, or the target fails naming them before it reads a report. ReportCoverage searches RootDirectory / "TestResults" for **/*cobertura*.xml (including timestamped MTP reports and hidden directories), merges everything it finds, renders the chosen format, appends a markdown block to $GITHUB_STEP_SUMMARY when that variable is set, and fails the build when line or branch coverage is below threshold.

The target attaches itself to ICompile through TryDependsOn, so it hooks into an existing build without requiring you to implement ICompile.

Parameters

Every value is validated once, before any report is read; an invalid value fails the target naming the parameter. Override CoverageSearchDirectory in your Build class to scan somewhere other than RootDirectory / "TestResults".

Outcomes

Parser warnings (malformed hit counts, contradictory branch data, ambiguous source roots, …) are logged one per line. Only an unresolved file identity changes the verdict, to NODATA. The badge is written before a failing verdict fails the target, so a drop turns it red; its colour is the outcome, and its message the line rate, plus the branch rate when a branch minimum is set. A non-passing gate keeps its own failure message when the badge cannot be written. To publish it to a branch, pass the directory to the badge action as badge-directory. An unwritable GITHUB_STEP_SUMMARY is logged as a warning and does not fail an otherwise passing gate. Percentages are invariant-formatted, so CI logs read 62.0% on every host, never 62,0%.

Parsing comes from DotCov: streaming XmlReader, no full-DOM load, DTDs ignored (never processed), external resolution disabled, bounded memory.

Also in this family

DotCov.Tool — the dotcov CLI · DotCov — the parser as a library

Feedback

Documentation · Issues · MIT