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.
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:
- Human readable changes between releases with native rendering by GitHub.
- Full link support to relative files in your repos.
- Link support for version changes that provide commits for the respective release.
- Link directly from your
README.mdto the change log completes a project and adds more legitimacy to your project.
A nascent changelog is created with markdown-changelog-new and
markdown-changelog-add-release is used to add a new entry.
An extensive changelog is available here.
Copyright © 2019 - 2020 Paul Landes
GNU Lesser General Public License, Version 2.0