Command

Update-BenchmarkEvidenceCatalog

Module: PSPublishModule
Inputs: PowerForge.BenchmarkRunResult
Outputs: PowerForge.BenchmarkEvidenceCatalog

Adds one normalized benchmark result to a platform-aware evidence catalog.

Syntax

Update-BenchmarkEvidenceCatalog
-ComparisonId <String>
[-ExpectedPlatform <String[]>]
-InputObject <BenchmarkRunResult>
[-Path] <String>
[-Platform <String>]
[-Publish]
[-ResultArtifactPath <String>]
-ResultPath <String>
-RunMode <String>
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Record a Windows publish lane

$capture = Start-BenchmarkProvenanceCapture -SourceRoot . -ArtifactRoot .\Build\BenchmarkDotNet.Artifacts -Metadata @{ 'benchmark.workload.id' = 'tabular-65k-v1' } -RunMode full
dotnet run -c Release --project .\Benchmarks -- --artifacts .\Build\BenchmarkDotNet.Artifacts
$capture | Complete-BenchmarkProvenanceCapture
$result = Import-BenchmarkResult .\Build\BenchmarkDotNet.Artifacts
$result | Update-BenchmarkEvidenceCatalog -Path .\Website\data\benchmark-index.json -ComparisonId tabular-65k-v1 -ResultPath windows-full.json -RunMode full -Publish

Parameters

-ComparisonId String required: Stable identifier shared only by equivalent workloads and fixture versions.
-ExpectedPlatform String[] optional: Platforms expected before the public comparison is complete.
-InputObject BenchmarkRunResult requiredpipeline: True (ByValue): Normalized benchmark result, usually supplied by Import-BenchmarkResult.
-Path String requiredposition: 0: Evidence catalog JSON path.
-Platform String optional: Producing operating-system platform for artifacts, such as BenchmarkDotNet CSV, that do not carry OS metadata. Conflicting embedded labels are rejected.
-Publish SwitchParameter optional: Marks this lane as suitable for public benchmark claims. Published evidence must contain successful measurements without failures, runtime and runner identity, and exact clean-worktree source provenance in metadata keys gitSha and gitWorktreeClean.
-ResultArtifactPath String optional: Optional local filesystem destination for the normalized result artifact. Specify this when ResultPath is a website URL or another portable consumer path rather than a local path.
-ResultPath String required: Portable path or URL to the normalized result consumed by the website.
-RunMode String required: Run mode such as quick or full.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.