ChangelogManagement

3.1.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

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

Install-PSResource -Name ChangelogManagement

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) 2023 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
- Get-ChangelogData now returns an additional `ChangeCount` property on `Unreleased` and `Released` properties. `ChangeCount` contains an integer count of the number of changes in that section. (Note that counts for individual change types in a section are available via `$OutputVariable.SECTION-NAME-HERE.Data.CHANGE-TYPE-HERE.Count` syntax.)

### Changed
- Pester test structure modernized and updated to offer increased coverage and more test cases

### Fixed
- Now documented that AzureDevOps option for Update-Changelog's LinkMode requires default branch be main

FileList

Version History

Version Downloads Last updated
3.1.0 (current version) 33,956 8/2/2023
3.0.1 16,209 12/12/2022
3.0.0 2,326 11/4/2022
2.1.4 30,834 2/5/2020
2.1.3 2,730 3/6/2019
2.1.2 335 2/13/2019
2.1.1 67 2/11/2019
2.1.0 53 2/8/2019
2.0.0 778 1/28/2019
1.0.0 555 10/20/2018
Show more