v2.0.1: add symbols and (more) documentation

Author: CodeCasterNL

.github/workflows/Publish-Package.yml

@@ -35,8 +35,10 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
           fail_on_unmatched_files: true # needs action-gh-release@v2 but that doesn't exist yet, gives a warning now
-          files: '**/*.nupkg'
+          files: |
+            **/*.nupkg
+            **/*.snupkg
 
     - name: Release to NuGet.org
       if: startsWith(github.ref, 'refs/tags/')
-      run: nuget push **/*.nupkg -Source 'https://api.nuget.org/v3/index.json' -ApiKey ${{secrets.NUGET_API_KEY}} -NoSymbols
+      run: nuget push **/*.nupkg -Source 'https://api.nuget.org/v3/index.json' -ApiKey ${{secrets.NUGET_API_KEY}}

Readme.md

@@ -1,12 +1,18 @@
 # WindowsServiceExtensions
-Make a .NET Core Windows Service that runs `IHostedService` background services power event aware.
+Make a .NET Core Windows Service that runs `IHostedService` background services power event aware. On consumer OS Windows 10, shutting down the computer will actually hibernate the OS. Services won't get another OnStart call.
 
-On consumer OS Windows 10, shutting down the computer will actually hibernate the OS. Services won't get another OnStart call.
+This project exists of a few classes that make building reliable Windows Services easier. The Lifetime class also include [kmcclellan's fixes](https://github.com/dotnet/runtime/issues/50019#issuecomment-678658133) that make the service throw when something fails on startup, instead of reprorting it started successfully.
 
-These extensions allow your IHostedServices to respond to this power state change:
+## Installation
+Through [NuGet](https://www.nuget.org/packages/CodeCaster.WindowsServiceExtensions/):
+
+    > Install-Package CodeCaster.WindowsServiceExtensions
+
+## Usage
+These extensions allow your IHostedServices to respond to this power state change.:
 
 * On your Host Builder, call `UsePowerEventAwareWindowsService()` instead of [`UseWindowsService()`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.windowsservicelifetimehostbuilderextensions.usewindowsservice?view=dotnet-plat-ext-3.1).
 * Instead of letting your service inherit [`Microsoft.Extensions.Hosting.BackgroundService`](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.hosting.backgroundservice?view=dotnet-plat-ext-5.0), inherit from `CodeCaster.WindowsServiceExtensions.PowerEventAwareBackgroundService`.
-* Implement the method `public override bool OnPowerEvent(PowerBroadcastStatus powerStatus)`
+* Implement the method `public override bool OnPowerEvent(PowerBroadcastStatus powerStatus)` and do your thing when it's called with a certain status.
 
 Do note that the statuses received can vary. You get either `ResumeSuspend`, `ResumeAutomatic` or both, never neither, after a machine wake, reboot or boot. 

src/CodeCaster.WindowsServiceExtensions/CodeCaster.WindowsServiceExtensions.csproj

@@ -3,30 +3,30 @@
   <PropertyGroup>
     <TargetFramework>net5.0</TargetFramework>
     <Nullable>enable</Nullable>
+    
+    <Version>2.0.1</Version>
+    <PackageId>CodeCaster.WindowsServiceExtensions</PackageId>
+    <PackageTags>Windows Service;Power event;IHostedService;BackgroundService;</PackageTags>
+
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <PackageProjectUrl>https://github.com/CodeCasterNL/WindowsServiceExtensions</PackageProjectUrl>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    
     <RepositoryUrl>https://github.com/CodeCasterNL/WindowsServiceExtensions</RepositoryUrl>
-    <RepositoryType>GitHub</RepositoryType>
-    <PackageTags></PackageTags>
+    <RepositoryType>git</RepositoryType>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
-    <PackageLicenseFile>LICENSE</PackageLicenseFile>
+
     <Authors>CodeCaster</Authors>
-    <Company />
-    <Copyright>CodeCaster</Copyright>
+    <Company>CodeCaster</Company>
+    <Copyright>© 2021 CodeCaster</Copyright>
     <Description>Makes your .NET 5 BackgroundServices power-event-aware.</Description>
-    <Version>2.0.0</Version>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="5.0.1" />
   </ItemGroup>
 
-  <ItemGroup>
-    <None Include="..\..\LICENSE">
-      <Pack>True</Pack>
-      <PackagePath></PackagePath>
-    </None>
-  </ItemGroup>
-
 </Project>

src/CodeCaster.WindowsServiceExtensions/PowerEventAwareWindowsServiceLifetime.cs

@@ -25,6 +25,7 @@ public class PowerEventAwareWindowsServiceLifetime : WindowsServiceLifetime, IHo
         private readonly IHostApplicationLifetime _applicationLifetime;
         private IReadOnlyCollection<IPowerEventAwareHostedService>? _hostedServices;
 
+        /// <inheritdoc />
         public PowerEventAwareWindowsServiceLifetime(IServiceProvider serviceProvider, IHostEnvironment environment, IHostApplicationLifetime applicationLifetime, ILoggerFactory loggerFactory, IOptions<HostOptions> optionsAccessor)
             : base(environment, applicationLifetime, loggerFactory, optionsAccessor)
         {
@@ -38,6 +39,7 @@ public PowerEventAwareWindowsServiceLifetime(IServiceProvider serviceProvider, I
             }
         }
 
+        /// <inheritdoc />
         public new async Task WaitForStartAsync(CancellationToken cancellationToken)
         {
             _logger.LogInformation("Windows Service start requested");
@@ -88,6 +90,7 @@ protected override bool OnPowerEvent(PowerBroadcastStatus powerStatus)
             return true;
         }
 
+        /// <inheritdoc />
         protected override void OnStart(string[] args)
         {
             _logger.LogInformation("Windows Service OnStart() was called");