Home

Awesome

Create and maintain changelogs.

MELPA badge MELPA stable badge Build Status

Create and maintain Keep a Changelog changelogs, which adheres to Semantic Versioning. This library creates a new change log and adds releases to the change long by keeping the markdown links consistent with changes. These links then (can) point back to GitHub as version diffs that show the commit history changes for the respective release.

Motivation

According to Semantic Versioning:

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. [Developers keep a change log] to make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

You kill the following birds with one stone using markdown change logs:

Usage

A nascent changelog is created with markdown-changelog-new and markdown-changelog-add-release is used to add a new entry.

Changelog

An extensive changelog is available here.

License

Copyright © 2019 - 2020 Paul Landes

GNU Lesser General Public License, Version 2.0

<!-- links -->