Update-BenchmarkEvidenceCatalog

Namespace PSPublishModule

Inputs

PowerForge.BenchmarkRunResult

Outputs

PowerForge.BenchmarkEvidenceCatalog

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

Remarks

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

Examples

Authored help example

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

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.

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

Parameters

ComparisonId String requiredposition: namedpipeline: False: Stable identifier shared only by equivalent workloads and fixture versions.
ExpectedPlatform String[] optionalposition: namedpipeline: False: Platforms expected before the public comparison is complete.
InputObject BenchmarkRunResult requiredposition: namedpipeline: True (ByValue): Normalized benchmark result, usually supplied by Import-BenchmarkResult.
Path String requiredposition: 0pipeline: False: Evidence catalog JSON path.
Platform String optionalposition: namedpipeline: False: Producing operating-system platform for artifacts, such as BenchmarkDotNet CSV, that do not carry OS metadata. Conflicting embedded labels are rejected.
Publish SwitchParameter optionalposition: namedpipeline: False: 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 optionalposition: namedpipeline: False: 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 requiredposition: namedpipeline: False: Portable path or URL to the normalized result consumed by the website.
RunMode String requiredposition: namedpipeline: False: Run mode such as quick or full.

Outputs

PowerForge.BenchmarkEvidenceCatalog