Update benchmarks nightly

Author: ejsmith

.github/scripts/Update-BenchmarkDocs.ps1

@@ -0,0 +1,95 @@
+<#
+.SYNOPSIS
+    Runs benchmarks and updates the performance documentation page.
+
+.DESCRIPTION
+    This script runs the Foundatio.Mediator benchmarks using BenchmarkDotNet,
+    then parses the CSV results and generates a compact markdown table for
+    the docs/guide/performance.md page.
+
+.PARAMETER SkipBenchmarks
+    Skip running benchmarks and only update docs from existing results.
+
+.EXAMPLE
+    ./Update-BenchmarkDocs.ps1
+
+.EXAMPLE
+    ./Update-BenchmarkDocs.ps1 -SkipBenchmarks
+#>
+
+param(
+    [switch]$SkipBenchmarks
+)
+
+$ErrorActionPreference = 'Stop'
+
+# Configuration - .github/scripts -> .github -> repo root (2 levels up)
+$RepoRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
+if (-not $RepoRoot -or -not (Test-Path $RepoRoot)) {
+    $RepoRoot = Get-Location
+}
+
+$BenchmarkProject = Join-Path $RepoRoot 'benchmarks/Foundatio.Mediator.Benchmarks'
+$ResultsFile = Join-Path $BenchmarkProject 'BenchmarkDotNet.Artifacts/results/Foundatio.Mediator.Benchmarks.CoreBenchmarks-report.csv'
+$PerfDoc = Join-Path $RepoRoot 'docs/guide/performance.md'
+
+# Run benchmarks if not skipped
+if (-not $SkipBenchmarks) {
+    Write-Host "Running benchmarks..." -ForegroundColor Cyan
+    Push-Location $BenchmarkProject
+    try {
+        dotnet run -c Release -- --exporters csv
+        if ($LASTEXITCODE -ne 0) {
+            throw "Benchmark run failed with exit code $LASTEXITCODE"
+        }
+    }
+    finally {
+        Pop-Location
+    }
+}
+
+# Verify results file exists
+if (-not (Test-Path $ResultsFile)) {
+    throw "Benchmark results file not found: $ResultsFile"
+}
+
+Write-Host "Parsing benchmark results..." -ForegroundColor Cyan
+
+# Parse CSV and build markdown table
+$csv = Import-Csv $ResultsFile
+$currentDate = Get-Date -Format 'yyyy-MM-dd'
+
+# Build the markdown content
+$markdown = @"
+# Performance
+
+Foundatio Mediator achieves near-direct call performance through C# interceptors and source generators, eliminating runtime reflection.
+
+## Benchmark Results
+
+> 📊 **Last Updated:** $currentDate
+> 🔧 **Generated automatically by [GitHub Actions](https://github.com/FoundatioFx/Foundatio.Mediator/actions/workflows/benchmarks.yml)**
+
+| Method | Mean | Allocated |
+|:-------|-----:|----------:|
+"@
+
+foreach ($row in $csv) {
+    $markdown += "`n| $($row.Method) | $($row.Mean) | $($row.Allocated) |"
+}
+
+$markdown += @"
+
+
+## Running Benchmarks Locally
+
+``````bash
+cd benchmarks/Foundatio.Mediator.Benchmarks
+dotnet run -c Release
+``````
+"@
+
+# Write the file
+$markdown | Out-File -FilePath $PerfDoc -Encoding utf8 -NoNewline
+
+Write-Host "Performance documentation updated: $PerfDoc" -ForegroundColor Green

.github/workflows/benchmarks.yml

@@ -0,0 +1,58 @@
+name: Benchmarks
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Run daily at 2:00 AM UTC
+    - cron: '0 2 * * *'
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/scripts/Update-BenchmarkDocs.ps1'
+      - '.github/workflows/benchmarks.yml'
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '10.0.x'
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build solution
+      run: dotnet build -c Release --no-restore
+
+    - name: Run benchmarks and update docs
+      shell: pwsh
+      run: .github/scripts/Update-BenchmarkDocs.ps1
+
+    - name: Commit and push changes
+      run: |
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+
+        # Check if there are changes to commit
+        if git diff --quiet docs/guide/performance.md; then
+          echo "No changes to commit"
+          exit 0
+        fi
+
+        git add docs/guide/performance.md
+        git commit -m "📊 Update benchmark results [skip ci]"
+        
+        # Pull with rebase in case changes were pushed while benchmarks ran
+        git pull --rebase origin main
+        git push

.vscode/tasks.json

@@ -30,6 +30,16 @@
 			"problemMatcher": [
 				"$msCompile"
 			]
+		},
+		{
+			"label": "update benchmark docs",
+			"type": "shell",
+			"command": "pwsh",
+			"args": [
+				"-File",
+				"${workspaceFolder}/.github/scripts/Update-BenchmarkDocs.ps1"
+			],
+			"problemMatcher": []
 		}
 	]
 }

docs/.vitepress/config.ts

@@ -53,7 +53,7 @@ export default withMermaid(defineConfig({
           items: [
             { text: 'Cascading Messages', link: '/guide/cascading-messages' },
             { text: 'Streaming Handlers', link: '/guide/streaming-handlers' },
-            { text: 'Performance & Interceptors', link: '/guide/performance' },
+            { text: 'Performance', link: '/guide/performance' },
             { text: 'Configuration Options', link: '/guide/configuration' },
             { text: 'Troubleshooting', link: '/guide/troubleshooting' }
           ]