ChangelogManagement

3.0.0

ChangelogManagement is a PowerShell module for reading and manipulating changelog files in [Keep a Changelog 1.0.0](https://keepachangelog.com/en/1.0.0/) format.

The primary feature is automatic updating of changelogs at release time in a CI/CD workflow via Update-Changelog.

Other features include:

- Creating new changelog files via New-Changelog
- Adding data to c
ChangelogManagement is a PowerShell module for reading and manipulating changelog files in [Keep a Changelog 1.0.0](https://keepachangelog.com/en/1.0.0/) format.

The primary feature is automatic updating of changelogs at release time in a CI/CD workflow via Update-Changelog.

Other features include:

- Creating new changelog files via New-Changelog
- Adding data to changelog files via Add-ChangelogData
- Getting changelog contents (parsed into a PowerShell object) via Get-ChangelogData
- Converting changelogs into other formats via ConvertFrom-Changelog
Show more

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name ChangelogManagement -RequiredVersion 3.0.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name ChangelogManagement -Version 3.0.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) 2022 Nate Scherer. All rights reserved.

Package Details

Author(s)

  • Nate Scherer

Tags

Changelog Tools Build Release

Functions

Add-ChangelogData ConvertFrom-Changelog Get-ChangelogData New-Changelog Update-Changelog

Dependencies

This module has no dependencies.

Release Notes

### Added
- New LinkModes 'GitHub' and 'AzureDevOps' on Update-Changelog which remove the need to manually specify a LinkPattern
- New property 'ReleaseNotes' returned by Get-ChangelogData containing a formatted version of the changes from the most recent released version

### Changed
- BREAKING CHANGE: New-Changelog now populates an initial change 'Added: Initial release'. This can be overridden to match previous behavior via the new '-NoInitialChange' parameter
- BREAKING CHANGE: Get-ChangelogData's Output.Unreleased is now null if there are no unreleased changes to match the behavior of Output.Released
- BREAKING CHANGE: Minimum supported PowerShell raised to 5.1 instead of 5.0
- Module structure changed to use dot-sourcing
- Build/test/deploy switched from Azure DevOps to GitHub Actions

### Fixed
- Add-ChangelogData now detects type of newline used in file rather than assuming it matches [System.Environment]::NewLine
- Update-Changelog now detects type of newline used in file rather than assuming it matches [System.Environment]::NewLine
- Get-ChangelogData now detects type of newline used in file rather than assuming it matches [System.Environment]::NewLine

FileList

Version History

Version Downloads Last updated
3.1.0 17,257 8/2/2023
3.0.1 15,767 12/12/2022
3.0.0 (current version) 2,323 11/4/2022
2.1.4 30,822 2/5/2020
2.1.3 2,727 3/6/2019
2.1.2 332 2/13/2019
2.1.1 64 2/11/2019
2.1.0 50 2/8/2019
2.0.0 775 1/28/2019
1.0.0 552 10/20/2018
Show more