md-changelog

Handy command-line tool for managing changelog for your open source projects.

TODO:

• bash auto-complete with https://github.com/kislyuk/argcomplete
• support multiple modes: list (just list of entries) and group (entries grouped by entry types: Features, Bugfixes, Improvements, etc)
• Git post-commit hook integration
• Git tag integration

Install

pip3 install md-changelog

Quickstart

cd <project_path>

md-changelog init  # it creates .md-changelog.cfg and Changelog.md in the current folder

Open with editor

md-changelog edit

Add message entry

md-changelog <entry type> <msg> [--split-by='<delimiter>']

# Examples
md-changelog message "My message"
md-changelog improvement "Code cleanup"
md-changelog bugfix "Fixed main loop"
md-changelog feature "Implemented new feature"
md-changelog breaking "Some breaking change"

# Add multiple entries the same type at once
md-changelog improvement --split-by=';' "Code cleanup; New command-line --split-by key; Improved feature X"

Changelog may look like

Changelog
=========

0.1.0+1 (UNRELEASED)
--------------------
* My message
* [Improvement] Code cleanup
* [Bugfix] Fixed main loop
* [Feature] Implemented new feature

Auto-message (not implemented)

md-changelog auto-message "${some_var_from_git_commit_post_hook}"

Show last changelog entry

md-changelog last

New release

Release currently unreleased version. Release assumes to set a release date to the current and update the last version (basically 0.1.0+1 -> 0.1.1 or 0.2.0, etc)

# Open in editor to update version manually
md-changelog release

# Set the version explicitly
md-changelog release -v 1.0.0

# Without confirmation dialog
md-changelog release -v 1.0.0 --force-yes

Append new unreleased entry

md-changelog append
md-changelog append --no-edit  # just add a new entry without calling editor