Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 1.54 KB

Get-ChangelogData.md

File metadata and controls

61 lines (43 loc) · 1.54 KB
external help file Module Name online version schema
ChangelogManagement-help.xml
ChangelogManagement
2.0.0

Get-ChangelogData

SYNOPSIS

Takes a changelog in Keep a Changelog 1.0.0 format and parses the data into a PowerShell object.

SYNTAX

Get-ChangelogData [[-Path] <String>] [<CommonParameters>]

DESCRIPTION

Takes a changelog in Keep a Changelog 1.0.0 format and parses the data into a PowerShell object.

EXAMPLES

EXAMPLE 1

Get-ChangelogData
Returns an object containing Header, Unreleased, Released, Footer, and LastVersion properties.

PARAMETERS

-Path

Path to the changelog; defaults to ".\CHANGELOG.md"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: CHANGELOG.md
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

This cmdlet does not accept pipeline input.

OUTPUTS

This cmdlet outputs a PSCustomObject containing the changelog data.

NOTES

RELATED LINKS

https://github.com/natescherer/ChangelogManagement