Add "Consume nightly build" docs (#454)

* add nightly build docs * fix images
2019-06-30 18:07:14 +02:00
parent 1c81b5b092
commit e159335949
5 changed files with 61 additions and 0 deletions
@@ -0,0 +1,56 @@
+# Consume nightly build
+
+You can check metadata of nightly build packages here:
+
+Msbuild https://www.myget.org/feed/coverlet-dev/package/nuget/coverlet.msbuild  
+VSTest collector https://www.myget.org/feed/coverlet-dev/package/nuget/coverlet.collector  
+.Net tools https://www.myget.org/feed/coverlet-dev/package/nuget/coverlet.console  
+
+To consume nightly build create a `NuGet.Config` on your root solution directory and add following content
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <!-- Coverlet nightly build feed -->
+    <add key="coverletNightly" value="https://www.myget.org/F/coverlet-dev/api/v3/index.json" /> 
+    <!-- Defaul nuget feed -->
+    <add key="nuget" value="https://api.nuget.org/v3/index.json" /> 
+    <!-- Add all other needed feed -->
+  </packageSources>
+</configuration>
+```
+
+### Install packages
+
+You can install nightly package using visual studio
+
+![File](images/nightly.PNG)
+
+Nuget(PM console)
+```
+PM> Install-Package coverlet.msbuild -Version 2.6.25-g6209239d69 -Source https://www.myget.org/F/coverlet-dev/api/v3/index.json
+```
+
+.NET CLI
+```
+ dotnet add package coverlet.msbuild --version 2.6.25-g6209239d69 --source https://www.myget.org/F/coverlet-dev/api/v3/index.json
+```
+
+.csproj
+
+```
+<PackageReference Include="coverlet.msbuild" Version="2.6.25-g6209239d69" />
+```
+
+### How to verify version
+
+You can understand which version you're using comparing nightly build release date and repo commits.  
+For instance if we want to consume last msbuild nightly build:
+* Go to https://www.myget.org/feed/coverlet-dev/package/nuget/coverlet.msbuild
+* Scroll down the page and check release date 
+![File](images/nightly_1.PNG)
+* Go to repo commits and compare date and first part of commit hash
+![File](images/nightly_2.PNG)
+
+As you can see we build at 00.00 UTC and build takes some seconds, so it's possible that release date won't be the same of commit repo.
@@ -101,6 +101,11 @@ _Note: The assembly you'd like to get coverage for must be different from the as

 If you're using [Cake Build](https://cakebuild.net) for your build script you can use the [Cake.Coverlet](https://github.com/Romanx/Cake.Coverlet) add-in to provide you extensions to dotnet test for passing Coverlet arguments in a strongly typed manner.

+## Consume nightly build
+
+We offer nightly build of master for all packages.
+See the [documentation](Documentation/ConsumeNightlyBuild.md)
+
 ## Issues & Contributions

 If you find a bug or have a feature request, please report them at this repository's issues section. See the [CONTRIBUTING GUIDE](CONTRIBUTING.md) for details on building and contributing to this project.