Skip to main content

Automatic version bumping for Keep-a-Changelog style Changelog files.

Project description

kac

A command line tool for bumping Changelogs that follow the Keep A Changelog standard.

Install

pip install kac

Run

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

Example

Assuming you have a Changelog file at v3.6.2 name CHANGELOG.md in your current directory.

  1. Run kac
    $ kac
    
  2. Choose a bump version
    ? Please select a new version (currently v3.6.2)  (Use arrow keys)
       v3.6.3
     » v3.7.0
       v4.0.0
    
  3. Confirm version bump (Y / Enter)
    ? Bump Changelog to v3.7.0? (Y/n)
    
  4. Changelog bumped
    Changelog bumped to v3.7.0!
    

Limitations

  • 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 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.1.3
Filename, size File type Python version Upload date Hashes
Filename, size kac-0.1.3-py3-none-any.whl (5.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size kac-0.1.3.tar.gz (4.4 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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page