Skip to main content

A command line tool for CHANGELOG files that follow the Keep-a-Changelog standard.

Project description

kac

A command line tool for CHANGELOG files that follow the Keep A Changelog standard.

Usage

Run kac in the same directory as your Changelog. By default, kac looks for a file called CHANGELOG.md (case-insensitive).

Usage: kac [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  bump  Bump a Changelog.
  copy  Copy a version's release text.

Limitations

  • Must be run in the same directory as your CHANGELOG file
  • Assumes you have changes in the "Unreleased" section
  • Only works for semver
  • Only supports versions in the MAJOR.MINOR.PATCH format. A beta version ending in -beta, for example, will fail.

To-Do

  • [ ] Add default text for versions with no notable changes
  • [ ] Add tests
  • [ ] Add support for generating an empty Changelog template
  • [ ] Undo bump
  • [ ] Support labels for pre-release and build metadata

Project details


Download files

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

Files for kac, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size kac-0.2.2-py3-none-any.whl (7.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size kac-0.2.2.tar.gz (5.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page