logchange - Changelog manager

View, update and format your changelog anywhere!

Features

• Keeps your changelog in Keep a Changelog style
• Supports version bumping from semver
• Comes with a CLI tool logchange
• Respects MarkDown
• Created for CI and scripts

Installation

python -m pip install logchange

Usage

CLI

See examples/cli.sh folder.

# create CHANGELOG.md if it does not exist
# or reformat existing (please check changes manually)
logchange init -f

# add new release
cat NOTES_0.1.0.md | logchange add 0.1.0
# or
logchange add 0.2.0 -i `cat NOTES_0.2.0.md`

# update existing or create a new section in latest release
logchange add latest added -i 'New feature'
# or
logchange add latest -i 'Added: New feature'

# set unreleased section
logchange set unreleased fixed -i 'Unreleased fix'

# list released versions
logchange list
< 0.1.0
< 0.2.0

# check release notes sections
logchange get 0.1.0 added
< - New awesome feature
< - Another feature

GitHub Actions

See workflows folder.

Versioning

logchange version follows PEP 440.

Latest changes

Full changelog can be found in Releases.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to PEP 440 -- Version Identification and Dependency Specification.

[Unreleased]

[0.2.0] - 2021-03-14

[0.2.0rc9] - 2021-03-14

[0.2.0rc8] - 2021-03-14

[0.2.0rc7] - 2021-03-14

[0.1.2] - 2021-02-26

[0.1.2rc2] - 2021-02-26

[0.1.2rc1] - 2021-02-26

Added

• added <text> CLI command to update Unreleased section
• changed <text> CLI command to update Unreleased section
• deprecated <text> CLI command to update Unreleased section
• removed <text> CLI command to update Unreleased section
• fixed <text> CLI command to update Unreleased section
• security <text> CLI command to update Unreleased section
• release <version> CLI command to move Unreleased section to release notes

Changed

• Release notes can now have text other than keep-a-changelog entries
• get command no longer raises an error on non-existing CHANGELOG.md
• Added support for Python 3.6.10+

Fixed

• Empty releases were not added to changelog
• Codeblocks are no longer removed from release notes
• Indented sections were not parsed properly

[0.1.1] - 2021-02-26

Initial release