Project

PSPublishModule

Build, test, version, sign, and publish PowerShell modules with reusable PowerForge pipelines.

View on GitHub Releases Get package
Stars 48
Forks 16
PowerShell Gallery downloads 17,213
Release v3.0.186
Language: C# Updated: 2026-11-04
Command

Update-BenchmarkDocument

Module
PSPublishModule
Inputs
None
Outputs
PowerForge.BenchmarkDocumentUpdateResult

Updates a marker-delimited benchmark block in a Markdown document.

Syntax

Update-BenchmarkDocument
-BlockId <String>
[-ComparisonPath <String>]
[-Path] <String>
[-Renderer <String>]
[-SummaryPath <String>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Update README benchmark block from a summary file

Update-BenchmarkDocument -Path .\README.MD -BlockId managed-module-benchmark-table -SummaryPath .\Build\Benchmarks\summary.json

Parameters

-BlockId String required
Marker block identifier.
-ComparisonPath String optional
Optional comparison JSON path.
-Path String requiredposition: 0
Markdown document path.
-Renderer String optional
Renderer name. Use SummaryTable or ComparisonTable.
-SummaryPath String optional
Summary JSON path.

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.