Build & deploy doc site (#167)

Author: mgrosperrin

.editorconfig

@@ -1,14 +1,17 @@
 # You can learn more about editorconfig here: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
-[*.{csproj,props}]
+
+#use soft tabs (spaces) for indentation
+indent_style = space
+
+[*.{csproj,props,yml}]
 indent_size = 2
+
 [*.cs]
 
 #Core editorconfig formatting - indentation
 
-#use soft tabs (spaces) for indentation
-indent_style = space
-
 #Formatting - indentation options
+indent_size = 4
 
 #indent switch case contents.
 csharp_indent_case_contents = true

.github/workflows/buildAndPublish.yml

@@ -1,17 +1,17 @@
 on:
-  workflow_call: 
+  workflow_call:
     inputs:
       feedUrl:
-        description: 'NuGet feed URL'
+        description: "NuGet feed URL"
         required: true
         type: string
       forRelease:
-        description: 'Run for release?'
+        description: "Run for release?"
         required: true
         type: boolean
     secrets:
       feedAPIKey:
-        description: 'NuGet feed API key'
+        description: "NuGet feed API key"
         required: true
 
 jobs:
@@ -20,42 +20,42 @@ jobs:
       fail-fast: false
     runs-on: windows-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
-    - name: Git Semantic Version
-      id: version
-      uses: PaulHatch/semantic-version@v5.4.0
-      with:
-        tag_prefix: ''
-        version_format: "${major}.${minor}.${patch}${{ !inputs.forRelease && '-preview${increment}' || '' }}"
-        search_commit_body: true
+      - name: Git Semantic Version
+        id: version
+        uses: PaulHatch/semantic-version@v5.4.0
+        with:
+          tag_prefix: ""
+          version_format: "${major}.${minor}.${patch}${{ !inputs.forRelease && '-preview${increment}' || '' }}"
+          search_commit_body: true
 
-    - name: Setup dotnet ${{ env.DOTNET_VERSION }}
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: ${{ env.DOTNET_VERSION }}
+      - name: Setup dotnet ${{ env.DOTNET_VERSION }}
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
 
-    - name: Build and Pack
-      run: dotnet build -c Release -p:Version=${{ steps.version.outputs.version}}
+      - name: Build and Pack
+        run: dotnet build -c Release -p:Version=${{ steps.version.outputs.version}}
 
-    - name: Run tests
-      run: dotnet test -c Release --no-build
+      - name: Run tests
+        run: dotnet test -c Release --no-build
 
-    - name: Upload dotnet test results
-      uses: dorny/test-reporter@v1.8.0
-      if: ${{ !cancelled() }}
-      with:
-        name: .NET Tests
-        path: 'TestResults/**/*.trx'
-        reporter: dotnet-trx
-        fail-on-error: true
-          
-    - name: Push to NuGet package feed
-      env:
-        NUGET_URL: ${{ inputs.feedUrl }}
-        NUGET_API_KEY: ${{ secrets.feedAPIKey }}
-      run: dotnet nuget push '**/*.nupkg' --source "$($env:NUGET_URL)" --api-key "$($env:NUGET_API_KEY)"
-      if: github.event_name == 'push'
+      - name: Upload dotnet test results
+        uses: dorny/test-reporter@v1.8.0
+        if: ${{ !cancelled() }}
+        with:
+          name: .NET Tests
+          path: "TestResults/**/*.trx"
+          reporter: dotnet-trx
+          fail-on-error: true
+
+      - name: Push to NuGet package feed
+        env:
+          NUGET_URL: ${{ inputs.feedUrl }}
+          NUGET_API_KEY: ${{ secrets.feedAPIKey }}
+        run: dotnet nuget push '**/*.nupkg' --source "$($env:NUGET_URL)" --api-key "$($env:NUGET_API_KEY)"
+        if: github.event_name == 'push'

.github/workflows/ci.yml

@@ -27,3 +27,6 @@ jobs:
       forRelease: false
     secrets:
       feedAPIKey: ${{ secrets.MYGET_CI_API_KEY }}
+
+  generate_docs:
+    uses: ./.github/workflows/generateDocs.yml

.github/workflows/generateDocs.yml

@@ -0,0 +1,19 @@
+on:
+  workflow_call:
+    inputs: {}
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build documenation site
+        uses: nunit/docfx-action@v3.1.0
+        with:
+          args: docs/docfx.json
+      - name: Upload documentation archive
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: artifacts/_site

.github/workflows/release.yml

@@ -3,14 +3,14 @@ name: Release
 on:
   push:
     tags:
-    - '*.*.*'
-    
+      - "*.*.*"
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 env:
-    DOTNET_VERSION: '8.0.x'
+  DOTNET_VERSION: "8.0.x"
 
 permissions:
   checks: write
@@ -26,18 +26,8 @@ jobs:
       feedAPIKey: ${{ secrets.NUGET_API_KEY }}
 
   generate_docs:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-    - name: Build documenation site
-      uses: nunit/docfx-action@v3.1.0
-      with:
-        args: docs/docfx.json
-    - name: Upload documentation archive
-      uses: actions/upload-pages-artifact@v3
-      with:
-        path: artifacts/_site
+    uses: ./.github/workflows/generateDocs.yml
+    
   publish_docs:
     needs: [call_buildAndPublish, generate_docs]
     permissions:
@@ -48,6 +38,6 @@ jobs:
       url: ${{ steps.deployment.outputs.url }}
     runs-on: ubuntu-latest
     steps:
-    - name: Publish documentation
-      uses: actions/deploy-pages@v4
-      id: deployment
+      - name: Publish documentation
+        uses: actions/deploy-pages@v4
+        id: deployment

Directory.Packages.props

@@ -20,7 +20,6 @@
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
     <PackageVersion Include="Moq" Version="4.20.70" />
     <PackageVersion Include="Seq.Extensions.Logging" Version="8.0.0" />
-    <PackageVersion Include="SourceLink.Create.CommandLine" Version="2.8.3" PrivateAssets="All" />
     <PackageVersion Include="System.ComponentModel.Annotations" Version="5.0.0" />
     <PackageVersion Include="xunit" Version="2.7.0" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.5.7">