Show-PackageUpdateReleaseNote

For AI agents: a documentation index is available at /llms.txt; a markdown version of this page is available at /docs/commands/show-packageupdatereleasenote/index.md.

SYNOPSIS

Displays release notes for one or more PowerShell modules.

SYNTAX

ByPackageUpdeInfoObject

Show-PackageUpdateReleaseNote [[-InputObject] <Info[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ByModuleObject

Show-PackageUpdateReleaseNote [[-Module] <psmoduleinfo[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Retrieves and displays release notes for module information objects produced by Get-PackageUpdateInfo or Import-PackageUpdateInfo, or for module objects returned by Get-Module. When release notes are available as a URL, the cmdlet attempts to resolve and retrieve the content so that the notes can be presented directly to the caller.

EXAMPLES

EXAMPLE 1

PS C:\> Get-PackageUpdateInfo | Show-PackageUpdateReleaseNote

Retrieves release notes for each module returned by Get-PackageUpdateInfo.

EXAMPLE 2

PS C:\> Get-Module PackageUpdateInfo | Show-PackageUpdateReleaseNote

Retrieves release notes for the PackageUpdateInfo module from the current PowerShell session.

EXAMPLE 3

PS C:\> Get-PackageUpdateInfo -Name PackageUpdateInfo | Show-PackageUpdateReleaseNote

Displays the release notes for a specific module using the output from Get-PackageUpdateInfo.

EXAMPLE 4

PS C:\> Get-PackageUpdateInfo | Show-PackageUpdateReleaseNote -WhatIf

Shows which modules would be processed for release note retrieval without performing the operation.

PARAMETERS

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Type: SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

One or more PackageUpdateInfo objects from Get-PackageUpdateInfo or Import-PackageUpdateInfo that contain release note information.

Type: Info[]
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Input
ParameterSets:
- Name: ByPackageUpdeInfoObject
  Position: 0
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Module

One or more module objects from Get-Module that contain release notes metadata or a release notes URL.

Type: PSModuleInfo[]
DefaultValue: ''
SupportsWildcards: false
Aliases:
- ModuleName
ParameterSets:
- Name: ByModuleObject
  Position: 0
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Type: SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

PackageUpdate.Info[]

System.Management.Automation.PSModuleInfo[]

OUTPUTS

PackageUpdate.ReleaseNote

NOTES

Version : 1.1.0.0 Author : Andi Bellstedt Date : 2026-06-21 Keywords : PackageUpdateInfo, Update, Module, ReleaseNote