Packing (#1)

bruno-garcia · web-flow · commit cdca5e092823 · 2017-11-26T00:58:12.000+01:00
* NuGet package info

* Appveyor publishes nupkg to github release on tag

* Documentation

* New appveyor encrypted github api key

* Change version if tag exists
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -1,6 +1,10 @@
 configuration: Release
+version: '1.0.0-alpha-{build}'
 init:
   - git config --global core.autocrlf true
+  # If there's a tag, use that as the version.
+  - ps: >-
+      if($env:APPVEYOR_REPO_TAG -eq "true"){Update-AppveyorBuild -Version "$env:APPVEYOR_REPO_TAG_NAME"}
 # Will build dependencies in release (optimize and portable pdbs) mode:
 build_script:
   - cmd: for /f %%a in ('dir /b test') do dotnet test -c Release test/%%a/%%a.csproj
@@ -15,7 +19,6 @@ environment:
     DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
     DOTNET_CLI_TELEMETRY_OPTOUT: 1
 test: off
-deploy: off
 os: Visual Studio 2017
 dotnet_csproj:
   patch: true
@@ -24,4 +27,14 @@ dotnet_csproj:
   package_version: '{version}'
 artifacts:
 - path: '**\*.nupkg'
-  name: serialization-nuget-packages
+  name: serialization-nuget-packages
+# builds on tags will publish all nupkgs to GitHub as a Draft release
+deploy:
+  release: $(appveyor_build_version)
+  provider: GitHub
+  auth_token:
+    secure: DsKyNX5x7EJOCaRUpZu17qwOfpd/NWaZzmQd0aE62nBAGkqI3nASvvHfvoQTjL8y
+  artifact: /.*\.nupkg/
+  draft: true
+  on:
+    appveyor_repo_tag: true
diff --git a/README.md b/README.md
@@ -80,6 +80,6 @@ builder.AddXml(p => p.Factory = type => new XmlSerializer(type, new XmlRootAttri
 #### Highlights
 
 * Simple abstraction
-* Multiple serialization types supported
+* Multiple serialization formats supported
 * Pay for play: no unwanted dependencies
 * DI packages to consume with single line of code
diff --git a/src/Greentube.Serialization.All/Greentube.Serialization.All.csproj b/src/Greentube.Serialization.All/Greentube.Serialization.All.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Metapackage which includes all Greentube Serialization packages.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.DependencyInjection.Json/Greentube.Serialization.DependencyInjection.Json.csproj b/src/Greentube.Serialization.DependencyInjection.Json/Greentube.Serialization.DependencyInjection.Json.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Integration of Greentube.Serialization.Json with Microsoft.DependencyInjection.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>newtonsoft-json;json;aspnetcore;dependency-injection;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.DependencyInjection.MessagePack/Greentube.Serialization.DependencyInjection.MessagePack.csproj b/src/Greentube.Serialization.DependencyInjection.MessagePack/Greentube.Serialization.DependencyInjection.MessagePack.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Integration of Greentube.Serialization.MessagePack with Microsoft.DependencyInjection.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>msgpack;messagepack;aspnetcore;dependency-injection;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.DependencyInjection.ProtoBuf/Greentube.Serialization.DependencyInjection.ProtoBuf.csproj b/src/Greentube.Serialization.DependencyInjection.ProtoBuf/Greentube.Serialization.DependencyInjection.ProtoBuf.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Integration of Greentube.Serialization.ProtoBuf with Microsoft.DependencyInjection.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>protobuf-net;protobuf;protocol-buffers;aspnetcore;dependency-injection;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.DependencyInjection.Xml/Greentube.Serialization.DependencyInjection.Xml.csproj b/src/Greentube.Serialization.DependencyInjection.Xml/Greentube.Serialization.DependencyInjection.Xml.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Integration of Greentube.Serialization.Xml with Microsoft.DependencyInjection.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>xml;system.xml.serializer;aspnetcore;dependency-injection;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.DependencyInjection/Greentube.Serialization.DependencyInjection.csproj b/src/Greentube.Serialization.DependencyInjection/Greentube.Serialization.DependencyInjection.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Integration of Greentube.Serialization with Microsoft.DependencyInjection.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>aspnetcore;dependency-injection;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.DependencyInjection/SerializationBuilder.cs b/src/Greentube.Serialization.DependencyInjection/SerializationBuilder.cs
@@ -9,6 +9,9 @@ namespace Greentube.Serialization.DependencyInjection
     /// </summary>
     public class SerializationBuilder
     {
+        /// <summary>
+        /// ServiceCollection
+        /// </summary>
         public IServiceCollection Services { get; }
 
         internal SerializationBuilder(IServiceCollection services)
@@ -17,7 +20,7 @@ internal SerializationBuilder(IServiceCollection services)
         }
 
         /// <summary>
-        /// Adds the serializer of type <typeparam name="TSerializer"></typeparam> 
+        /// Adds the serializer of type TSerializer
         /// as the implemenatation of <see cref="ISerializer"/>
         /// </summary>
         /// <typeparam name="TSerializer">The implementation of <see cref="ISerializer"/></typeparam>
@@ -29,7 +32,7 @@ public void AddSerializer<TSerializer>(ServiceLifetime lifetime)
         }
 
         /// <summary>
-        /// Adds the serializer of type <typeparam name="TSerializer"></typeparam> 
+        /// Adds the serializer of type TSerializer
         /// as the implemenatation of <see cref="ISerializer"/>
         /// </summary>
         /// <typeparam name="TSerializer">The implementation of <see cref="ISerializer"/></typeparam>
diff --git a/src/Greentube.Serialization.Json/Greentube.Serialization.Json.csproj b/src/Greentube.Serialization.Json/Greentube.Serialization.Json.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard1.3</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>A JSON implementation of ISerializer provided by Greentube.Serialization</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>newtonsoft-json;json;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.Json/JsonOptions.cs b/src/Greentube.Serialization.Json/JsonOptions.cs
@@ -2,8 +2,14 @@
 
 namespace Greentube.Serialization.Json
 {
+    /// <summary>
+    /// JSON Options
+    /// </summary>
     public class JsonOptions
     {
+        /// <summary>
+        /// The encoding to use when serializing and deserializing
+        /// </summary>
         public Encoding Encoding { get; set; } = Encoding.UTF8;
     }
 }
diff --git a/src/Greentube.Serialization.Json/JsonSerializer.cs b/src/Greentube.Serialization.Json/JsonSerializer.cs
@@ -8,6 +8,10 @@ public class JsonSerializer : ISerializer
     {
         private readonly JsonOptions _options;
 
+        /// <summary>
+        /// Create a new instance of JsonSerializer
+        /// </summary>
+        /// <param name="options"></param>
         public JsonSerializer(JsonOptions options)
         {
             _options = options ?? throw new ArgumentNullException(nameof(options));
diff --git a/src/Greentube.Serialization.MessagePack/Greentube.Serialization.MessagePack.csproj b/src/Greentube.Serialization.MessagePack/Greentube.Serialization.MessagePack.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>A MessagePack implementation of ISerializer provided by Greentube.Serialization</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>msgpack;messagepack;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.ProtoBuf/Greentube.Serialization.ProtoBuf.csproj b/src/Greentube.Serialization.ProtoBuf/Greentube.Serialization.ProtoBuf.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard1.3</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>A Protocol Buffers implementation of ISerializer provided by Greentube.Serialization</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>protobuf-net;protocol-buffers;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.ProtoBuf/ProtoBufOptions.cs b/src/Greentube.Serialization.ProtoBuf/ProtoBufOptions.cs
@@ -2,8 +2,14 @@
 
 namespace Greentube.Serialization.ProtoBuf
 {
+    /// <summary>
+    /// ProtoBuf Options
+    /// </summary>
     public class ProtoBufOptions
     {
+        /// <summary>
+        /// The runtime type model
+        /// </summary>
         public RuntimeTypeModel RuntimeTypeModel { get; set; } = RuntimeTypeModel.Default;
     }
 }
diff --git a/src/Greentube.Serialization.ProtoBuf/ProtoBufSerializer.cs b/src/Greentube.Serialization.ProtoBuf/ProtoBufSerializer.cs
@@ -8,6 +8,10 @@ public class ProtoBufSerializer : ISerializer
     {
         private readonly ProtoBufOptions _options;
 
+        /// <summary>
+        /// Creates a new instance of ProtoBufSerializer
+        /// </summary>
+        /// <param name="options"></param>
         public ProtoBufSerializer(ProtoBufOptions options)
         {
             _options = options ?? throw new ArgumentNullException(nameof(options));
diff --git a/src/Greentube.Serialization.Xml/Greentube.Serialization.Xml.csproj b/src/Greentube.Serialization.Xml/Greentube.Serialization.Xml.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard1.3</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>An XML implementation of ISerializer provided by Greentube.Serialization</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>xml;system.xml.serializer;serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
diff --git a/src/Greentube.Serialization.Xml/XmlSerializer.cs b/src/Greentube.Serialization.Xml/XmlSerializer.cs
@@ -12,6 +12,10 @@ public class XmlSerializer : ISerializer
     {
         private readonly XmlOptions _options;
 
+        /// <summary>
+        /// Creates a new instance of XmlSerializer
+        /// </summary>
+        /// <param name="options"></param>
         public XmlSerializer(XmlOptions options)
         {
             _options = options ?? throw new ArgumentNullException(nameof(options));
diff --git a/src/Greentube.Serialization/Greentube.Serialization.csproj b/src/Greentube.Serialization/Greentube.Serialization.csproj
@@ -2,6 +2,12 @@
   <PropertyGroup>
     <TargetFramework>netstandard1.0</TargetFramework>
     <PackageVersion>0.0.0</PackageVersion>
+    <Authors>Bruno Garcia</Authors>
+    <Owners>Bruno Garcia; Greentube</Owners>
+    <Description>Provides a common contract for serialization.</Description>
+    <PackageProjectUrl>https://github.com/Greentube/serialization</PackageProjectUrl>
+    <PackageTags>serialization;common-serialization;ISerializer</PackageTags>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Coverage|AnyCPU'">
     <DebugType>full</DebugType>
