ChangelogManagement

A PowerShell module for reading and manipulating changelog files in Keep a Changelog 1.0.0 format.

View on GitHub

New-Changelog

SYNOPSIS

Creates a new, blank changelog in Keep a Changelog 1.0.0 format.

SYNTAX

New-Changelog [[-Path] <String>] [-NoSemVer] [-NoInitialChange] [<CommonParameters>]

DESCRIPTION

This cmdlet creates a new, blank changelog in Keep a Changelog 1.0.0 format.

EXAMPLES

EXAMPLE 1

New-Changelog
Does not generate output, but creates a new changelog at .\CHANGELOG.md

EXAMPLE 2

New-Changelog -Path project\CHANGELOG.md -NoSemVer
Does not generate output, but creates a new changelog at project\CHANGELOG.md while excluding SemVer statement from the header

PARAMETERS

-Path

The path to output the changelog file; 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

-NoSemVer

Exclude the statement about Semantic Versioning from the changelog

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-NoInitialChange

Don't include the default initial change "Added: Initial release"

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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 does not generate output.

NOTES

https://github.com/natescherer/ChangelogManagement