Merge pull request #95 from Stravaig-Projects/#88-refactor

88 Refactor in prep for different logging scenarios

Author: colinangusmackay

.github/workflows/build.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches: 
       - main
+      - '#88-refactor'
 
     paths-ignore:
       - 'README.md'
@@ -38,9 +39,8 @@ jobs:
     name: Build, Test, and Release
     runs-on: ubuntu-latest
     env:
-      STRAVAIG_SOLUTION: src/Stravaig.Extensions.Configuration.Diagnostics.sln
-      STRAVAIG_TESTS: Stravaig.Extensions.Configuration.Diagnostics.Tests
-      STRAVAIG_PROJECT: Stravaig.Extensions.Configuration.Diagnostics
+      STRAVAIG_SOLUTION: src/Stravaig.Configuration.Diagnostics.sln
+      STRAVAIG_TESTS: Stravaig.Configuration.Diagnostics.Tests
 
     steps:
       - name: Check out code
@@ -56,7 +56,6 @@ jobs:
         run: |
           echo "GITHUB_SHA: $GITHUB_SHA" 
           echo "Solution: $STRAVAIG_SOLUTION"
-          echo "Project: $STRAVAIG_PROJECT"
           echo "Tests: $STRAVAIG_TESTS"
           echo "Package version: $STRAVAIG_PACKAGE_VERSION"
           echo "Version Suffix: $STRAVAIG_PACKAGE_VERSION_SUFFIX"
@@ -78,11 +77,11 @@ jobs:
 
       - name: Package Preview Release
         if: ${{ env.STRAVAIG_IS_PREVIEW == 'true' }}
-        run: dotnet pack ./src/$STRAVAIG_PROJECT/$STRAVAIG_PROJECT.csproj --configuration Release --output ./out --include-symbols --include-source /p:VersionPrefix="$STRAVAIG_PACKAGE_VERSION" --version-suffix "$STRAVAIG_PACKAGE_VERSION_SUFFIX" -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
+        run: dotnet pack $STRAVAIG_SOLUTION --configuration Release --output ./out --include-symbols --include-source /p:VersionPrefix="$STRAVAIG_PACKAGE_VERSION" --version-suffix "$STRAVAIG_PACKAGE_VERSION_SUFFIX" -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
 
       - name: Package Stable Release
         if: ${{ env.STRAVAIG_IS_STABLE == 'true' }}
-        run: dotnet pack ./src/$STRAVAIG_PROJECT/$STRAVAIG_PROJECT.csproj --configuration Release --output ./out --include-symbols --include-source /p:VersionPrefix="$STRAVAIG_PACKAGE_VERSION" -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
+        run: dotnet pack $STRAVAIG_SOLUTION --configuration Release --output ./out --include-symbols --include-source /p:VersionPrefix="$STRAVAIG_PACKAGE_VERSION" -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
 
       - name: Push package to NuGet
         if: ${{ env.STRAVAIG_PUBLISH_TO_NUGET == 'true' }}

Build-LocalPackages.ps1

@@ -0,0 +1,51 @@
+[CmdletBinding()]
+param (
+    [ValidateScript({Test-Path $_ -PathType Container})]
+    [parameter(Mandatory=$false)]
+    $NugetFileShare = "C:\dev\nuget"
+)
+
+function Get-NextVersion($VersionFile)
+{
+    # Work out the version number
+    $nextVersion = Get-Content $VersionFile -ErrorAction Stop
+    if ($null -eq $nextVersion)
+    {
+        Write-Error "The $VersionFile file is empty"
+        Exit 1
+    }
+    if ($nextVersion.GetType().BaseType.Name -eq "Array")
+    {
+        $nextVersion = $nextVersion[0]
+        Write-Warning "$VersionFile contains more than one line of text. Using the first line."
+    }
+    if ($nextVersion -notmatch "^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$")
+    {
+        Write-Error "The contents of $VersionFile (`"$nextVersion`") not recognised as a valid version number."
+        Exit 2
+    }
+    
+    return $nextVersion;
+}
+
+function Get-PackageVersionSuffix()
+{
+    $now = Get-Date
+    $datePart = $now.ToString("yyMMdd.HHmm");
+    return "lp.$datePart";
+}
+
+$VersionFile = "$PSScriptRoot/version.txt";
+$STRAVAIG_SOLUTION = "$PSScriptRoot/src/Stravaig.Configuration.Diagnostics.sln"
+$STRAVAIG_PACKAGE_VERSION = Get-NextVersion -VersionFile $VersionFile;
+$STRAVAIG_PACKAGE_VERSION_SUFFIX = Get-PackageVersionSuffix;
+
+Get-ChildItem ./out -Recurse | Remove-Item;
+
+dotnet pack $STRAVAIG_SOLUTION --configuration Release --output ./out --include-symbols --include-source /p:VersionPrefix="$STRAVAIG_PACKAGE_VERSION" --version-suffix "$STRAVAIG_PACKAGE_VERSION_SUFFIX" -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
+
+Get-ChildItem ./out/*.nupkg | ForEach-Object {
+    $name = $_.FullName;
+    Write-Output "Pushing $name";
+    dotnet nuget push "$name" --source $NugetFileShare
+}

Example/Example.csproj

@@ -9,7 +9,7 @@
         <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="5.0.1" NoWarn="NU1605" />
         <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="5.0.1" NoWarn="NU1605" />
         <PackageReference Include="Seq.Extensions.Logging" Version="6.0.0" />
-        <PackageReference Include="Stravaig.Extensions.Configuration.Diagnostics" Version="0.5.0-preview.153" />
+        <PackageReference Include="Stravaig.Configuration.Diagnostics.Logging" Version="0.6.0-lp.210213.1710" />
         <PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" />
     </ItemGroup>
 

Example/Startup.cs

@@ -5,7 +5,9 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Microsoft.OpenApi.Models;
-using Stravaig.Extensions.Configuration.Diagnostics;
+using Stravaig.Configuration.Diagnostics;
+using Stravaig.Configuration.Diagnostics.Extensions;
+using Stravaig.Configuration.Diagnostics.Logging;
 
 namespace Example
 {

Set-Version.ps1

@@ -17,28 +17,34 @@ function ConvertTo-Boolean([string]$Value, [bool]$EmptyDefault)
     throw "Don't know how to convert `"$Value`" into a Boolean."
 }
 
+function Get-NextVersion($VersionFile)
+{
+    # Work out the version number
+    $nextVersion = Get-Content $VersionFile -ErrorAction Stop
+    if ($null -eq $nextVersion)
+    {
+        Write-Error "The $VersionFile file is empty"
+        Exit 1
+    }
+    if ($nextVersion.GetType().BaseType.Name -eq "Array")
+    {
+        $nextVersion = $nextVersion[0]
+        Write-Warning "$VersionFile contains more than one line of text. Using the first line."
+    }
+    if ($nextVersion -notmatch "^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$")
+    {
+        Write-Error "The contents of $VersionFile (`"$nextVersion`") not recognised as a valid version number."
+        Exit 2
+    }
+
+    return $nextVersion;
+}
+
 [bool]$IsPreview = ConvertTo-Boolean -Value $IsPreview -EmptyDefault $true;
 [bool]$IsPublicRelease = ConvertTo-Boolean -Value $IsPublicRelease -EmptyDefault $false;
 
 $VersionFile = "$PSScriptRoot/version.txt";
-
-# Work out the version number
-$nextVersion = Get-Content $VersionFile -ErrorAction Stop
-if ($null -eq $nextVersion)
-{
-    Write-Error "The $VersionFile file is empty"
-    Exit 1
-}
-if ($nextVersion.GetType().BaseType.Name -eq "Array")
-{
-    $nextVersion = $nextVersion[0]
-    Write-Warning "$VersionFile contains more than one line of text. Using the first line."
-}
-if ($nextVersion -notmatch "^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$")
-{
-    Write-Error "The contents of $VersionFile (`"$nextVersion`") not recognised as a valid version number."
-    Exit 2
-}
+$nextVersion = Get-NextVersion -VersionFile $VersionFile;
 "STRAVAIG_PACKAGE_VERSION=$nextVersion" | Out-File -FilePath $Env:GITHUB_ENV -Encoding UTF8 -Append
 $fullVersion = $nextVersion;
 

docs/intro/installing-the-package.rst

@@ -3,28 +3,35 @@
 Installing
 ==========
 
-The latest package is available on `NuGet`_. 
+This library is made up of several packages. The core functionality is contained in a package called ``Stravaig.Configuration.Diagnostics.Core``, the Logger extensions are in ``Stravaig.Configuration.Diagnostics.Logging``.
 
-.. _NuGet: https://www.nuget.org/packages/Stravaig.Extensions.Configuration.Diagnostics
+All the packages that contain the final output form (e.g. Logging) also reference the Core package, so there is no need to include that separately. It also means that you only have one package 
 
-+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
-| Badge                                                                                                                                    | Notes                     |
-+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
-| .. image:: https://img.shields.io/nuget/v/Stravaig.Extensions.Configuration.Diagnostics?color=004880&label=nuget%20stable&logo=nuget     | Latest stable             |
-+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
-| .. image:: https://img.shields.io/nuget/vpre/Stravaig.Extensions.Configuration.Diagnostics?color=ffffff&label=nuget%20latest&logo=nuget) | Latest, including preview |
-+------------------------------------------------------------------------------------------------------------------------------------------+---------------------------+
+The latest packages are available on `NuGet`_. 
 
-Latest, including preview
+.. _NuGet: https://www.nuget.org/packages?q=Stravaig.Configuration.Diagnostics
+
+.. list-table:: packages
+   :header-rows: 1
+
+   * - Package
+     - Stable Version
+     - Preview Version
+   * - Stravaig.Configuration.Diagnostics.Core
+     - .. image:: https://img.shields.io/nuget/v/Stravaig.Configuration.Diagnostics.Core?color=004880&label=nuget%20stable&logo=nuget
+     - .. image:: https://img.shields.io/nuget/vpre/Stravaig.Configuration.Diagnostics.Core?color=ffffff&label=nuget%20latest&logo=nuget)
+   * - Stravaig.Configuration.Diagnostics.Logging
+     - .. image:: https://img.shields.io/nuget/v/Stravaig.Configuration.Diagnostics.Logging?color=004880&label=nuget%20stable&logo=nuget
+     - .. image:: https://img.shields.io/nuget/vpre/Stravaig.Configuration.Diagnostics.Logging?color=ffffff&label=nuget%20latest&logo=nuget)
 
 Installing from a PowerShell prompt
 -----------------------------------
 
-You can install the package into your project from a PowerShell prompt. Navigate to the folder your project file is in and type: ::
+You can install the package into your project from a PowerShell prompt. Navigate to the folder your project file is in and type:
 
 ::
 
-    Install-Package Stravaig.Extensions.Configuration.Diagnostics
+    Install-Package Stravaig.Configuration.Diagnostics.Logging
 
 Installing using the .NET CLI
 -----------------------------
@@ -33,5 +40,5 @@ You can install the package into your project with the .NET CLI command. Navigat
 
 ::
 
-    dotnet add package Stravaig.Extensions.Configuration.Diagnostics
+    dotnet add package Stravaig.Configuration.Diagnostics.Logging
 

release-notes/wip-release-notes.md

@@ -4,13 +4,17 @@
 
 Date: ???
 
+**THIS RELEASE CONTAINS BREAKING CHANGES**
+
+
 ### Bugs
 
 ### Features
 
 ### Miscellaneous
 
-- #84 Update List-Contributors script
+* #84 Update List-Contributors script
+* #88 Refactor internal structure to support different logging frameworks by creating a new "Core" package, with the specifics for various logging frameworks ultimately residing in various satellite packages.
 
 ### Dependabot
 

src/.editorconfig

@@ -1,4 +1,6 @@
 
+root=true
+
 [*]
 charset=utf-8
 end_of_line=crlf