Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natescherer/ChangelogManagement
A PowerShell module for reading and manipulating changelog files in Keep a Changelog 1.0.0 format.
https://github.com/natescherer/ChangelogManagement
changelog keep-a-changelog powershell
Last synced: 3 months ago
JSON representation
A PowerShell module for reading and manipulating changelog files in Keep a Changelog 1.0.0 format.
- Host: GitHub
- URL: https://github.com/natescherer/ChangelogManagement
- Owner: natescherer
- License: mit
- Created: 2018-10-09T21:45:36.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T11:47:08.000Z (7 months ago)
- Last Synced: 2024-05-18T05:33:58.195Z (6 months ago)
- Topics: changelog, keep-a-changelog, powershell
- Language: PowerShell
- Homepage:
- Size: 587 KB
- Stars: 20
- Watchers: 3
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- jimsghstars - natescherer/ChangelogManagement - A PowerShell module for reading and manipulating changelog files in Keep a Changelog 1.0.0 format. (PowerShell)
README
# ChangelogManagement
[](https://natescherer.github.io/ChangelogManagement/testreports/Windows_powershell/Windows_powershell.html)
[](https://natescherer.github.io/ChangelogManagement/testreports/Windows_pwsh/Windows_pwsh.html)
[](https://natescherer.github.io/ChangelogManagement/testreports/Linux_pwsh/Linux_pwsh.html)
[](https://natescherer.github.io/ChangelogManagement/testreports/macOS_pwsh/macOS_pwsh.html)
[](https://codecov.io/gh/natescherer/ChangelogManagement)
[](#contributors-)
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
## Getting Started
ChangelogManagement is designed to be cross-platform and fully compatible with Windows PowerShell 5.1 and PowerShell 7+ on Windows/Linux/macOS.
### Prerequisites
No prerequisites are required beyond having PowerShell installed.
### Installing
ChangelogManagement is listed in the PowerShell Gallery [here](https://www.powershellgallery.com/packages/ChangelogManagement), which means you can install on any internet-connected computer running PowerShell 5.1+ by running this command:
```PowerShell
Install-Module -Name ChangelogManagement
```
## Usage
### Examples
``` PowerShell
LinkPattern = @{
FirstRelease = "https://github.com/testuser/testrepo/tree/v{CUR}"
NormalRelease = "https://github.com/testuser/testrepo/compare/v{PREV}..v{CUR}"
Unreleased = "https://github.com/testuser/testrepo/compare/v{CUR}..HEAD"
}
Update-Changelog -ReleaseVersion 1.1.1 -LinkMode Automatic -LinkPattern $LinkPattern
```
- Does not generate output, but:
- Takes all Unreleased changes in .\CHANGELOG.md and adds them to a new release tagged with ReleaseVersion and today's date.
- Updates links according to LinkPattern.
- Creates a new, blank Unreleased section.
``` PowerShell
New-Changelog
```
- Does not generate output, but creates a new changelog at .\CHANGELOG.md.
``` PowerShell
Add-ChangelogData -Type "Added" -Data "Spanish language translation"
```
- Does not generate output, but adds a new Added change into changelog at .\CHANGELOG.md.
``` PowerShell
Get-ChangelogData
```
- Returns an object containing Header, Unreleased, Released, Footer, and LastVersion properties.
``` PowerShell
ConvertFrom-Changelog -Path .\CHANGELOG.md -Format Release -OutputPath docs\CHANGELOG.md
```
- Does not generate output, but creates a file at docs\CHANGELOG.md that is the same as the input with the Unreleased section removed.
### Documentation
For detailed documentation, [click here on GitHub](docs), see the docs folder in a release, or run Get-Help for the individual function in PowerShell.
## Questions/Comments
If you have questions, comments, etc, please enter a GitHub Issue with the "question" tag.
## Contributing/Bug Reporting
Contributions and bug reports are gladly accepted! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## Building
Building is unnecessary, per se. The provided build YAML generates documentation files and metadata, then does the actual releasing and publishing. If modifying locally, you can simply use the updated .psd1/.psm1 files without running a build process.
## Contributors
Nate Scherer
💻 📖 🚇
James Charlesworth
💻
Gael
💻
Johan Ljunggren
💻
This project follows the [all-contributors](https://allcontributors.org) specification.
Contributions of any kind are welcome!
## License
This project is licensed under The MIT License - see [LICENSE](LICENSE) for details.
## Acknowledgements
[](https://cloudsmith.com)
Package repository hosting is graciously provided by Cloudsmith.