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.169
Language: C# Updated: 2026-10-13

API Reference

Command

Update-BenchmarkDocument

Namespace PSPublishModule
Inputs
None
Outputs
PowerForge.BenchmarkDocumentUpdateResult

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

Remarks

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

Examples

Authored help example

Update README benchmark block from a summary file


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

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-BenchmarkDocument -BlockId <String> [-ComparisonPath <String>] -Path <String> [-Renderer <String>] [-SummaryPath <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

BlockId String requiredposition: namedpipeline: False
Marker block identifier.
ComparisonPath String optionalposition: namedpipeline: False
Optional comparison JSON path.
Path String requiredposition: 0pipeline: False
Markdown document path.
Renderer String optionalposition: namedpipeline: False
Renderer name. Use SummaryTable or ComparisonTable.
SummaryPath String optionalposition: namedpipeline: False
Summary JSON path.

Outputs

PowerForge.BenchmarkDocumentUpdateResult