diff --git a/Documentation/DriversFeatures.md b/Documentation/DriversFeatures.md new file mode 100644 index 000000000..08914ffe7 --- /dev/null +++ b/Documentation/DriversFeatures.md @@ -0,0 +1,19 @@ +# Driver feature differences + +Since the beginning all coverlet drivers shared the same coverage engine. +Since version 3.0.0 we decided to consolidate versioning across drivers so for every new release all drivers will have the same version number. +We think that keeping the versions in sync express better the set of features every release will have. +This does not mean that all drivers will support every functionality/feature or have the same behaviours, since they are limited by the context they're running in. +In the table below we keep track of main differences: + +| Feature | MsBuild | .NET Tool | DataCollectors | +|----------|:-------------:|-------------:|----------------:| +| .NET Core support(>= 2.0) | Yes | Yes |Yes | +| .NET Framework support(>= 4.6.1) | Yes | Yes |Yes(since 3.0.0) | +| Show result on console | Yes | Yes | No | +| Deterministic reports output folder | Yes | Yes |No | +| Merge reports | Yes | Yes |No | +| Coverage threshold validation | Yes | Yes |No | + + +If possible we advice you to use the collectors integration (vstest engine integration), since it is fully integrated inside the test pipeline and does not suffer of the [known issues](KnownIssues.md) of the other drivers. \ No newline at end of file diff --git a/README.md b/README.md index 1aac4d094..0c17bba7e 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Coverlet is a cross platform code coverage framework for .NET, with support for # Main contents * [QuickStart](#Quick-Start) * [How It Works](#How-It-Works) +* [Drivers features differences](Documentation/DriversFeatures.md) * [Deterministic build support](#Deterministic-build-support) * [Known Issues](#Known-Issues) * [Consume nightly build](#Consume-nightly-build) diff --git a/src/coverlet.console/version.json b/src/coverlet.console/version.json deleted file mode 100644 index e8488924b..000000000 --- a/src/coverlet.console/version.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "1.7.3-preview.{height}", - "publicReleaseRefSpec": [ - "^refs/heads/master$" - ], - "nugetPackageVersion":{ - "semVer": 2 - } -} diff --git a/src/coverlet.core/coverlet.core.csproj b/src/coverlet.core/coverlet.core.csproj index 6884abf7a..c1b2b0ecd 100644 --- a/src/coverlet.core/coverlet.core.csproj +++ b/src/coverlet.core/coverlet.core.csproj @@ -3,7 +3,7 @@ Library netstandard2.0 - 5.4.0 + 5.5.0 false diff --git a/src/coverlet.msbuild.tasks/version.json b/src/coverlet.msbuild.tasks/version.json deleted file mode 100644 index 8fd9f8a9b..000000000 --- a/src/coverlet.msbuild.tasks/version.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "2.9.1-preview.{height}", - "publicReleaseRefSpec": [ - "^refs/heads/master$" - ], - "nugetPackageVersion":{ - "semVer": 2 - } -} diff --git a/src/coverlet.collector/version.json b/version.json similarity index 86% rename from src/coverlet.collector/version.json rename to version.json index e9b8f1bd0..d33c14a43 100644 --- a/src/coverlet.collector/version.json +++ b/version.json @@ -1,6 +1,6 @@ { "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "1.3.1-preview.{height}", + "version": "3.0.0-preview.{height}", "publicReleaseRefSpec": [ "^refs/heads/master$" ],