WIP: MyGet Feed and README updates (protobuf-net#576)

NickCraver · mgravell · commit a3c80e34c226 · 2019-10-14T12:15:12.000+01:00
* Builds: add protobuf-net MyGet feed as a push target This will make https://www.myget.org/F/protobuf-net/api/v3/index.json light up for all protobuf-net packages once tests are greed and flowing. * README updates for v3 WIP tweaks to README for v3 and exposing packages more readily since there are multiple now. * Exclude VB and CSharp test projects * Examples.csproj cleanup * One more * Skip long running tests in CI This runs everything locally, but not the huge and disruptive ones in Appveyor - just an idea (and happy to revert) /cc @mgravell
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # protobuf-net
-protobuf-net is a contract based serializer for .NET code, that happens to write data in the "protocol buffers" serialization format engineered by Google. The API, however, is very different to Google's, and follows typical .NET patterns (it is broadly comparable, in usage, to XmlSerializer, DataContractSerializer, etc). It should work for most .NET languages that write standard types and can use attributes.
+protobuf-net is a contract based serializer for .NET code, that happens to write data in the "protocol buffers" serialization format engineered by Google. The API, however, is very different to Google's, and follows typical .NET patterns (it is broadly comparable, in usage, to `XmlSerializer`, `DataContractSerializer`, etc). It should work for most .NET languages that write standard types and can use attributes.
+
+[![Build status](https://ci.appveyor.com/api/projects/status/1pj6gk7h37bjn200/branch/master?svg=true)](https://ci.appveyor.com/project/StackExchange/protobuf-net/branch/master)
 
 ## Release Notes
 
@@ -10,17 +12,21 @@ To understand how protobuf-net relates to protobuf [see here](https://protobuf-n
 ---
 
 ## Supported Runtimes
-- .NET Framework 2.0+
-- .NET Standard 1.0+ (note that 1.0 is very restricted, and suits iOS etc; use the highest .NET Standard that works for your platform)
-- UAP 10.0(+?)
-
-It is possible to build for more specific TFMs, but *right now* I've simplified the build to those. If you need help
-with a custom build: let me know.
+- .NET Framework 4.6.1+
+- .NET Standard 2.0+
 
 ## Runtime Installation
 
-Packages are available on NuGet: [`protobuf-net`](https://www.nuget.org/packages/protobuf-net). You can use the following command in the Package Manager Console:
-`Install-Package protobuf-net`
+All stable and some pre-release packages are available on NuGet. CI Builds are available via MyGet (feed URL: `https://www.myget.org/F/protobuf-net/api/v3/index.json `).
+
+You can use the following command in the Package Manager Console:
+```ps
+Install-Package protobuf-net
+```
+
+| Package | NuGet Stable | NuGet Pre-release | Downloads | MyGet |
+| ------- | ------------ | ----------------- | --------- | ----- |
+| [protobuf-net](https://www.nuget.org/packages/protobuf-net/) | [![protobuf-net](https://img.shields.io/nuget/v/protobuf-net.svg)](https://www.nuget.org/packages/protobuf-net/) | [![protobuf-net](https://img.shields.io/nuget/vpre/protobuf-net.svg)](https://www.nuget.org/packages/protobuf-net/) | [![protobuf-net](https://img.shields.io/nuget/dt/protobuf-net.svg)](https://www.nuget.org/packages/protobuf-net/) | [![protobuf-net MyGet](https://img.shields.io/myget/protobuf-net/vpre/protobuf-net.svg)](https://www.myget.org/feed/protobuf-net/package/nuget/protobuf-net) |
 
 ## Basic usage
 
@@ -123,4 +129,4 @@ In v2, everything that can be done with attributes can also be configured at run
 
 ## Support
 
-I try to be responsive to [Stack Overflow questions in the `protobuf-net` tag](https://stackoverflow.com/questions/tagged/protobuf-net), [issues logged on github](https://github.com/protobuf-net/protobuf-net), [email](mailto:marc.gravell@gmail.com), etc. I don't currently offer a paid support channel. If I've helped you, feel free to [buy me a coffee](https://buymeacoff.ee/marcgravell).
+I try to be responsive to [Stack Overflow questions in the `protobuf-net` tag](https://stackoverflow.com/questions/tagged/protobuf-net), [issues logged on GitHub](https://github.com/protobuf-net/protobuf-net), [email](mailto:marc.gravell@gmail.com), etc. I don't currently offer a paid support channel. If I've helped you, feel free to [buy me a coffee](https://buymeacoff.ee/marcgravell).
diff --git a/appveyor.yml b/appveyor.yml
@@ -19,14 +19,21 @@ nuget:
 
 build_script:
   - cmd: dotnet build Build.csproj -c Release /p:CI=true /p:GeneratePackageOnBuild=false
-  - cmd: dotnet test Build.csproj -c Release
+  - cmd: dotnet test Build.csproj -c Release /p:CI=true
   - cmd: dotnet pack Build.csproj --no-build -c Release /p:Packing=true /p:PackageOutputPath=%CD%\.nupkgs /p:CI=true
 
 test: off
 artifacts:
 - path: .\.nupkgs\*.nupkg
 
 deploy:
+- provider: NuGet
+  server: https://www.myget.org/F/protobuf-net/api/v2
+  on:
+    branch: master
+  api_key:
+    secure: PV7ERAltWWLhy7AT2h+Vb5c1BM9/WFgvggb+rKyQ8hDg3fYqpZauYdidOOgt2lp4
+  symbol_server: https://www.myget.org/F/protobuf-net/symbols/api/v2/package
 - provider: NuGet
   server: https://www.myget.org/F/stackoverflow/api/v2
   on:
diff --git a/src/CSharpTest/CSharpTest.csproj b/src/CSharpTest/CSharpTest.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netcoreapp2.1</TargetFramework>
     <LangVersion>7.1</LangVersion>
+    <IsTestProject>false</IsTestProject>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="../protobuf-net/protobuf-net.csproj" />
diff --git a/src/Examples/DictionaryTests.cs b/src/Examples/DictionaryTests.cs
@@ -263,9 +263,9 @@ static void CheckNested<TInner>(IDictionary<string, TInner> data, string message
             Assert.Equal(2, inner.Keys.Count); //, message);
             Assert.Equal("pqr", inner["mno"]); //, message);
             Assert.Equal("vwx", inner["stu"]); //, message);
-
         }
 
+#if LONG_RUNNING
         [Fact]
         public void CheckPerformanceNotInsanelyBad()
         {
@@ -323,6 +323,8 @@ public void CheckPerformanceNotInsanelyBad()
             Log.WriteLine("Encoding: " + watch.ElapsedMilliseconds);
             
         }
+#endif
+
         const int LOOP = 500000;
         static int BulkTest<T>(TypeModel model, T obj, out int serialize, out int deserialize) where T: class
         {
diff --git a/src/Examples/Examples.csproj b/src/Examples/Examples.csproj
@@ -1,90 +1,58 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
-
   <PropertyGroup>
     <GenerateDocumentationFile>false</GenerateDocumentationFile>
     <TargetFrameworks>net462;netcoreapp3.0</TargetFrameworks>
-    <LibImport>net</LibImport>
     <Configurations>Debug;Release;VS</Configurations>
     <DefineConstants>NO_CODEGEN;NO_WCF;NO_ENYIM</DefineConstants>
+    <DefineConstants Condition="$(CI) != 'true'">$(DefineConstants);LONG_RUNNING</DefineConstants>
     <NoWarn>$(NoWarn);IDE0060;IDE0051;IDE0044;IDE0063;IDE0028;IDE0034;IDE1006;IDE0017;IDE0052;xUnit1004</NoWarn>
   </PropertyGroup>
   <PropertyGroup Condition="$(TargetFramework)=='netcoreapp3.0'">
     <DefineConstants>$(DefineConstants);FEAT_COMPILER;NO_NHIBERNATE;COREFX;NO_INTERNAL_CONTEXT;PLAT_SPANS</DefineConstants>
-    <LibImport>core</LibImport>
   </PropertyGroup>
   <PropertyGroup Condition="$(TargetFramework)=='net462'">
     <DefineConstants>$(DefineConstants);FEAT_COMPILER;FX30;NO_INTERNAL_CONTEXT;PLAT_SPANS;EMIT_DLL</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
-    <None Include="..\Tools\nwind.proto.bin">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-  <ItemGroup>
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
+    <ProjectReference Include="..\protobuf-net\protobuf-net.csproj" />
+    <ProjectReference Include="..\protobuf-net.Reflection\protobuf-net.Reflection.csproj" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.3.0" />
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.2" />
+    <PackageReference Include="Pipelines.Sockets.Unofficial" Version="2.0.25" />
+    <PackageReference Include="System.Collections.Immutable" Version="1.6.0" />
     <PackageReference Include="System.ValueTuple" Version="4.5.0" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
   </ItemGroup>
   <ItemGroup Condition="$(TargetFramework)=='net462'">
     <PackageReference Include="NHibernate" Version="4.1.1.4000" />
     <PackageReference Include="Iesi.Collections" Version="4.0.4" />
-  </ItemGroup>
-  <ItemGroup Condition="'$(LibImport)' == 'net'">
+    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="4.6.0" />
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="PresentationCore" />
     <Reference Include="System" />
-    <PackageReference Include="System.Collections.Immutable" Version="1.6.0" />
-    <Reference Include="System.configuration" />
+    <Reference Include="System.Configuration" />
+    <Reference Include="System.Core" />
     <Reference Include="System.Data" />
-    <Reference Include="System.Data.Linq">
-      <RequiredTargetFramework>3.5</RequiredTargetFramework>
-    </Reference>
-    <Reference Include="System.Drawing" />
+    <Reference Include="System.Data.Linq" />
+    <Reference Include="System.Runtime.Serialization" />
     <Reference Include="System.Runtime.Serialization.Formatters.Soap" />
     <Reference Include="System.Web.Extensions" />
-    <Reference Include="System.Xml" />
-    <Reference Include="System.Xml.Linq">
-      <RequiredTargetFramework>3.5</RequiredTargetFramework>
-    </Reference>
+    <Reference Include="System.ServiceModel" />
     <Reference Include="WindowsBase" />
-    <Reference Include="System.ServiceModel">
-      <RequiredTargetFramework>3.0</RequiredTargetFramework>
-    </Reference>
-    <Reference Include="System.Runtime.Serialization">
-      <RequiredTargetFramework>3.0</RequiredTargetFramework>
-    </Reference>
-    <Reference Include="System.ServiceModel.Web">
-      <RequiredTargetFramework>3.5</RequiredTargetFramework>
-    </Reference>
-    <Reference Include="System.Core">
-      <RequiredTargetFramework>3.5</RequiredTargetFramework>
-    </Reference>
-
-
   </ItemGroup>
-  <ItemGroup Condition="'$(LibImport)'=='core'">
-    <PackageReference Include="System.Collections.NonGeneric" Version="4.3.0" />
-    <PackageReference Include="System.Threading" Version="4.3.0" />
-    <PackageReference Include="System.Threading.Thread" Version="4.3.0" />
-    <PackageReference Include="System.Threading.ThreadPool" Version="4.3.0" />
+  <ItemGroup Condition="$(TargetFramework)=='netcoreapp3.0'">
+    <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.6.0" />
+    <PackageReference Include="System.Data.SqlClient" Version="4.7.0" />
+    <PackageReference Include="System.Reflection.TypeExtensions" Version="4.6.0" />
     <PackageReference Include="System.Runtime.Serialization.Primitives" Version="4.3.0" />
     <PackageReference Include="System.Runtime.Serialization.Xml" Version="4.3.0" />
-    <PackageReference Include="System.Reflection.TypeExtensions" Version="4.6.0" />
-    <PackageReference Include="System.Data.SqlClient" Version="4.7.0" />
+    <PackageReference Include="System.Threading.Thread" Version="4.3.0" />
+    <PackageReference Include="System.Threading.ThreadPool" Version="4.3.0" />
     <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
     <PackageReference Include="System.Runtime.Serialization.Primitives" Version="4.3.0" />
-    <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.6.0" />
-    <PackageReference Include="Pipelines.Sockets.Unofficial" Version="2.0.25" />
-  </ItemGroup>
-  <ItemGroup Condition="$(TargetFramework)=='net462'">
-    <PackageReference Include="Pipelines.Sockets.Unofficial" Version="2.0.25" />
-    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="4.6.0" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="System.Collections.Immutable" Version="1.6.0" />
-    <ProjectReference Include="..\protobuf-net\protobuf-net.csproj" />
-    <ProjectReference Include="..\protobuf-net.Reflection\protobuf-net.Reflection.csproj" />
-    <PackageReference Include="Newtonsoft.Json" Version="12.0.2" />
+    <None Include="..\Tools\nwind.proto.bin" CopyToOutputDirectory="PreserveNewest" />
   </ItemGroup>
 </Project>
diff --git a/src/Examples/Issues/SO13162642.cs b/src/Examples/Issues/SO13162642.cs
@@ -1,4 +1,5 @@
-﻿using Xunit;
+﻿#if LONG_RUNNING
+using Xunit;
 using ProtoBuf;
 using System.Collections.Generic;
 using System.IO;
@@ -69,3 +70,4 @@ class DTO
         }
     }
 }
+#endif
diff --git a/src/Examples/Issues/SO7727355.cs b/src/Examples/Issues/SO7727355.cs
@@ -1,5 +1,5 @@
-﻿using System;
-using System.Data;
+﻿#if LONG_RUNNING
+using System;
 using System.IO;
 using System.Threading;
 using Xunit;
@@ -94,3 +94,4 @@ private void PistonThread(object state)
         }
     }
 }
+#endif
diff --git a/src/Examples/StupidlyComplexModel.cs b/src/Examples/StupidlyComplexModel.cs
@@ -13,6 +13,7 @@ public class StupidlyComplexModel
         private ITestOutputHelper Log { get; }
         public StupidlyComplexModel(ITestOutputHelper _log) => Log = _log;
 
+#if LONG_RUNNING
         [Fact]
         public void TimeStupidlyComplexModel()
         {
@@ -23,6 +24,7 @@ public void TimeSimpleModel()
         {
             TimeModel<SimpleModel>(100);
         }
+#endif
 
         [ProtoContract]
         public class SimpleModel
@@ -68,7 +70,7 @@ private void TimeModel<T>(int count, Action<TypeModel, string> test = null)
                 typeof(T).Name, watch.ElapsedMilliseconds / count, typeCount, watch.ElapsedMilliseconds, count));
         }
 
-
+#if LONG_RUNNING
         [Fact]
         public void TestStupidlyComplexModel()
         {
@@ -84,6 +86,7 @@ public void TestStupidlyComplexModel()
             model.Compile("TestStupidlyComplexModel", "TestStupidlyComplexModel.dll");
             PEVerify.AssertValid("TestStupidlyComplexModel.dll");
         }
+#endif
 
         private void Test(TypeModel model, string test)
         {
@@ -3329,4 +3332,4 @@ public class Inner799 { [ProtoMember(1)] public int Value { get; set; } }
         public class Inner800 { [ProtoMember(1)] public int Value { get; set; } }
 
     }
-}
+}
diff --git a/src/VBTest/VBTest.vbproj b/src/VBTest/VBTest.vbproj
@@ -5,6 +5,7 @@
     <LangVersion>14</LangVersion>
     <RootNamespace />
     <NoWarn>IDE1006</NoWarn>
+    <IsTestProject>false</IsTestProject>
   </PropertyGroup>
   <!--
   9: ===3.5

Original file line number	Diff line number	Diff line change
`@@ -263,9 +263,9 @@ static void CheckNested<TInner>(IDictionary<string, TInner> data, string message`
`263`	`263`	`Assert.Equal(2, inner.Keys.Count); //, message);`
`264`	`264`	`Assert.Equal("pqr", inner["mno"]); //, message);`
`265`	`265`	`Assert.Equal("vwx", inner["stu"]); //, message);`
`266`		`-`
`267`	`266`	`}`
`268`	`267`
	`268`	`+#if LONG_RUNNING`
`269`	`269`	`[Fact]`
`270`	`270`	`public void CheckPerformanceNotInsanelyBad()`
`271`	`271`	`{`
`@@ -323,6 +323,8 @@ public void CheckPerformanceNotInsanelyBad()`
`323`	`323`	`Log.WriteLine("Encoding: " + watch.ElapsedMilliseconds);`
`324`	`324`
`325`	`325`	`}`
	`326`	`+#endif`
	`327`	`+`
`326`	`328`	`const int LOOP = 500000;`
`327`	`329`	`static int BulkTest<T>(TypeModel model, T obj, out int serialize, out int deserialize) where T: class`
`328`	`330`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using Xunit;`
	`1`	`+#if LONG_RUNNING`
	`2`	`+using Xunit;`
`2`	`3`	`using ProtoBuf;`
`3`	`4`	`using System.Collections.Generic;`
`4`	`5`	`using System.IO;`
`@@ -69,3 +70,4 @@ class DTO`
`69`	`70`	`}`
`70`	`71`	`}`
`71`	`72`	`}`
	`73`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`		`-using System;`
`2`		`-using System.Data;`
	`1`	`+#if LONG_RUNNING`
	`2`	`+using System;`
`3`	`3`	`using System.IO;`
`4`	`4`	`using System.Threading;`
`5`	`5`	`using Xunit;`
`@@ -94,3 +94,4 @@ private void PistonThread(object state)`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	`}`
	`97`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ public class StupidlyComplexModel`
`13`	`13`	`private ITestOutputHelper Log { get; }`
`14`	`14`	`public StupidlyComplexModel(ITestOutputHelper _log) => Log = _log;`
`15`	`15`
	`16`	`+#if LONG_RUNNING`
`16`	`17`	`[Fact]`
`17`	`18`	`public void TimeStupidlyComplexModel()`
`18`	`19`	`{`
`@@ -23,6 +24,7 @@ public void TimeSimpleModel()`
`23`	`24`	`{`
`24`	`25`	`TimeModel<SimpleModel>(100);`
`25`	`26`	`}`
	`27`	`+#endif`
`26`	`28`
`27`	`29`	`[ProtoContract]`
`28`	`30`	`public class SimpleModel`
`@@ -68,7 +70,7 @@ private void TimeModel<T>(int count, Action<TypeModel, string> test = null)`
`68`	`70`	`typeof(T).Name, watch.ElapsedMilliseconds / count, typeCount, watch.ElapsedMilliseconds, count));`
`69`	`71`	`}`
`70`	`72`
`71`		`-`
	`73`	`+#if LONG_RUNNING`
`72`	`74`	`[Fact]`
`73`	`75`	`public void TestStupidlyComplexModel()`
`74`	`76`	`{`
`@@ -84,6 +86,7 @@ public void TestStupidlyComplexModel()`
`84`	`86`	`model.Compile("TestStupidlyComplexModel", "TestStupidlyComplexModel.dll");`
`85`	`87`	`PEVerify.AssertValid("TestStupidlyComplexModel.dll");`
`86`	`88`	`}`
	`89`	`+#endif`
`87`	`90`
`88`	`91`	`private void Test(TypeModel model, string test)`
`89`	`92`	`{`
`@@ -3329,4 +3332,4 @@ public class Inner799 { [ProtoMember(1)] public int Value { get; set; } }`
`3329`	`3332`	`public class Inner800 { [ProtoMember(1)] public int Value { get; set; } }`
`3330`	`3333`
`3331`	`3334`	`}`
`3332`		`-}`
	`3335`	`+}`