Skip to main content

Keep-a-changelog manager

Project description

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'

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

logchange-0.1.2.tar.gz (10.6 kB view hashes)

Uploaded Source

Built Distribution

logchange-0.1.2-py3-none-any.whl (13.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page