Merge pull request #1 from TheAngryByrd/ci-support

CI and README

Author: TheAngryByrd

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,7 @@ Describe the big picture of your changes here to communicate to the maintainers
 
 ## Types of changes
 
-What types of changes does your code introduce to Redis.Streams?
+What types of changes does your code introduce to FSharp.Control.Redis.Streams?
 _Put an `x` in the boxes that apply_
 
 - [ ] Bugfix (non-breaking change which fixes an issue)

.paket/Paket.Restore.targets

@@ -252,11 +252,10 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <_NuspecFiles Include="$(AdjustedNuspecOutputPath)\*.$(PackageVersion.Split(`+`)[0]).nuspec"/>
+      <_NuspecFiles Include="$(AdjustedNuspecOutputPath)\*.$(PackageVersion).nuspec"/>
     </ItemGroup>
 
-    <Exec Condition="@(_NuspecFiles) != ''" Command='$(PaketCommand) fix-nuspecs files "@(_NuspecFiles)" project-file "$(PaketProjectFile)" ' />
-    <Error Condition="@(_NuspecFiles) == ''" Text='Could not find nuspec files in "$(AdjustedNuspecOutputPath)" (Version: "$(PackageVersion)"), therefore we cannot call "paket fix-nuspecs" and have to error out!' />
+    <Exec Command='$(PaketCommand) fix-nuspecs files "@(_NuspecFiles)" project-file "$(PaketProjectFile)" ' Condition="@(_NuspecFiles) != ''" />
 
     <ConvertToAbsolutePath Condition="@(_NuspecFiles) != ''" Paths="@(_NuspecFiles)">
       <Output TaskParameter="AbsolutePaths" PropertyName="NuspecFileAbsolutePath" />

.travis.yml

@@ -10,6 +10,8 @@ mono:
   - weekly # => "latest commits"
 os:
   - linux
+services:
+  - redis-server
 
 script:
   - ./build.sh

Directory.Build.props

@@ -2,12 +2,12 @@
     <PropertyGroup>
         <!-- summary is not migrated from project.json, but you can use the <Description> property for that if needed. -->
         <PackageTags>f#, fsharp</PackageTags>
-        <PackageProjectUrl>https://github.com/MyGithubUsername/Redis.Streams</PackageProjectUrl>
-        <PackageLicenseUrl>https://github.com/MyGithubUsername/Redis.Streams/blob/master/LICENSE.md</PackageLicenseUrl>
+        <PackageProjectUrl>https://github.com/TheAngryByrd/FSharp.Control.Redis.Streams</PackageProjectUrl>
+        <PackageLicenseUrl>https://github.com/TheAngryByrd/FSharp.Control.Redis.Streams/blob/master/LICENSE.md</PackageLicenseUrl>
         <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
         <RepositoryType>git</RepositoryType>
-        <Authors>MyGithubUsername</Authors>
-        <RepositoryUrl>https://github.com/MyGithubUsername/Redis.Streams</RepositoryUrl>
+        <Authors>TheAngryByrd</Authors>
+        <RepositoryUrl>https://github.com/TheAngryByrd/FSharp.Control.Redis.Streams</RepositoryUrl>
         <!-- owners is not supported in MSBuild -->
     </PropertyGroup>
 </Project>

README.md

@@ -1,22 +1,28 @@
-# Redis.Streams
+# FSharp.Control.Redis.Streams
 
-[Enter useful description for Redis.Streams]
+FSharp.Control.Redis.Streams is a library dedicated to bridging [Redis Streams](https://redis.io/topics/streams-intro) with .NET Streaming technologies.
+
+Currently Supported:
+
+- [Hopac Streams](https://hopac.github.io/Hopac/Hopac.html#def:module%20Hopac.Stream)
+- [Akka.net Streams](https://getakka.net/articles/streams/introduction.html)
+- [Reactive Extensions](http://reactivex.io/)
 
 ---
 
 ## Builds
 
 MacOS/Linux | Windows
 --- | ---
-[![Travis Badge](https://travis-ci.org/MyGithubUsername/Redis.Streams.svg?branch=master)](https://travis-ci.org/MyGithubUsername/Redis.Streams) | [![Build status](https://ci.appveyor.com/api/projects/status/github/MyGithubUsername/Redis.Streams?svg=true)](https://ci.appveyor.com/project/MyGithubUsername/Redis.Streams)
-[![Build History](https://buildstats.info/travisci/chart/MyGithubUsername/Redis.Streams)](https://travis-ci.org/MyGithubUsername/Redis.Streams/builds) | [![Build History](https://buildstats.info/appveyor/chart/MyGithubUsername/Redis.Streams)](https://ci.appveyor.com/project/MyGithubUsername/Redis.Streams)  
+[![Travis Badge](https://travis-ci.org/TheAngryByrd/FSharp.Control.Redis.Streams.svg?branch=master)](https://travis-ci.org/TheAngryByrd/FSharp.Control.Redis.Streams) | No Redis 5.0 Support On Windows
+[![Build History](https://buildstats.info/travisci/chart/TheAngryByrd/FSharp.Control.Redis.Streams)](https://travis-ci.org/TheAngryByrd/FSharp.Control.Redis.Streams/builds) |   
 
 
 ## Nuget 
 
 Stable | Prerelease
 --- | ---
-[![NuGet Badge](https://buildstats.info/nuget/Redis.Streams)](https://www.nuget.org/packages/Redis.Streams/) | [![NuGet Badge](https://buildstats.info/nuget/Redis.Streams?includePreReleases=true)](https://www.nuget.org/packages/Redis.Streams/)
+[![NuGet Badge](https://buildstats.info/nuget/FSharp.Control.Redis.Streams)](https://www.nuget.org/packages/FSharp.Control.Redis.Streams/) | [![NuGet Badge](https://buildstats.info/nuget/FSharp.Control.Redis.Streams?includePreReleases=true)](https://www.nuget.org/packages/FSharp.Control.Redis.Streams/)
 
 ### Developing
 
@@ -31,6 +37,16 @@ Make sure the following **requirements** are installed in your system:
 
 * [dotnet SDK](https://www.microsoft.com/net/download/core) 2.0 or higher
 * [Mono](http://www.mono-project.com/) if you're on Linux or macOS.
+* [docker-compose](https://docs.docker.com/compose/)
+
+
+Stand up redis via docker:
+
+```sh
+docker-compose up
+```
+
+Build:
 
 ```
 > build.cmd // on windows
@@ -43,6 +59,8 @@ $ ./build.sh  // on unix
   * `CONFIGURATION=Debug ./build.sh` will result in things like `dotnet build -c Debug`
 * `GITHUB_TOKEN` will be used to upload release notes and nuget packages to github.
   * Be sure to set this before releasing
+- `DISABLE_COVERAGE` Will disable running code coverage metrics.  AltCover can have [severe performance degradation](https://github.com/SteveGilham/altcover/issues/57) so it worth disabling when looking to do a quicker feedback loop.
+  - `DISABLE_COVERAGE=1 ./build.sh`
 
 ### Watch Tests
 

appveyor.yml

@@ -20,6 +20,20 @@ BuildServer.install [
     Travis.Installer
 ]
 
+let environVarAsBoolOrDefault varName defaultValue =
+    let truthyConsts = [
+        "1"
+        "Y"
+        "YES"
+        "T"
+        "TRUE"
+    ]
+    try
+        let envvar = (Environment.environVar varName).ToUpper()
+        truthyConsts |> List.exists((=)envvar)
+    with
+    | _ ->  defaultValue
+
 //-----------------------------------------------------------------------------
 // Metadata and Configuration
 //-----------------------------------------------------------------------------
@@ -42,7 +56,7 @@ let toolsDir = __SOURCE_DIRECTORY__  @@ "tools"
 let coverageThresholdPercent = 80
 let coverageReportDir =  __SOURCE_DIRECTORY__  @@ "docs" @@ "coverage"
 
-let gitOwner = "MyGithubUsername"
+let gitOwner = "TheAngryByrd"
 let gitRepoName = "FSharp.Control.Redis.Streams"
 
 let releaseBranch = "master"
@@ -52,6 +66,9 @@ let publishUrl = "https://www.nuget.org"
 
 let paketToolPath = __SOURCE_DIRECTORY__ </> ".paket" </> (if Environment.isWindows then "paket.exe" else "paket")
 
+
+let disableCodeCoverage = environVarAsBoolOrDefault "DISABLE_COVERAGE" false
+
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
@@ -172,7 +189,7 @@ let dotnetTest ctx =
     let args =
         [
             "--no-build"
-            "/p:AltCover=false"
+            sprintf "/p:AltCover=%b" (not disableCodeCoverage)
             sprintf "/p:AltCoverThreshold=%d" coverageThresholdPercent
             sprintf "/p:AltCoverAssemblyExcludeFilter=%s" excludeCoverage
         ]
@@ -370,7 +387,7 @@ Target.create "Release" ignore
 "DotnetRestore"
     ==> "DotnetBuild"
     ==> "DotnetTest"
-    ==> "GenerateCoverageReport"
+    =?> ("GenerateCoverageReport", not disableCodeCoverage)
     ==> "DotnetPack"
     ==> "SourcelinkTest"
     ==> "PublishToNuget"

build.fsx

@@ -35,4 +35,4 @@ then
   dotnet tool install paket --tool-path "$PAKET_TOOL_PATH"
 fi
 
-FAKE_DETAILED_ERRORS=true "$FAKE" build -t "$@"
+DISABLE_COVERAGE=1 FAKE_DETAILED_ERRORS=true "$FAKE" build -t "$@"