https://github.com/plandes/markdown-changelog
Create and maintain changelogs.
https://github.com/plandes/markdown-changelog
Last synced: 3 months ago
JSON representation
Create and maintain changelogs.
- Host: GitHub
- URL: https://github.com/plandes/markdown-changelog
- Owner: plandes
- License: gpl-2.0
- Created: 2019-07-25T12:20:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-05T17:23:43.000Z (about 2 years ago)
- Last Synced: 2025-02-21T20:25:16.289Z (8 months ago)
- Language: Emacs Lisp
- Size: 20.5 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Create and maintain changelogs.
[![MELPA badge][melpa-badge]][melpa-link]
[![MELPA stable badge][melpa-stable-badge]][melpa-stable-link]
[![Build Status][build-badge]][build-link]
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:
* 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.md` to the change log completes a project and
adds more legitimacy to your project.
## 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](CHANGELOG.md).
## License
Copyright © 2019 - 2020 Paul Landes
GNU Lesser General Public License, Version 2.0
[melpa-link]: https://melpa.org/#/markdown-changelog
[melpa-stable-link]: https://stable.melpa.org/#/markdown-changelog
[melpa-badge]: https://melpa.org/packages/markdown-changelog-badge.svg
[melpa-stable-badge]: https://stable.melpa.org/packages/markdown-changelog-badge.svg
[build-badge]: https://github.com/plandes/markdown-changelog/workflows/CI/badge.svg
[build-link]: https://github.com/plandes/markdown-changelog/actions
[Keep a Changelog]: https://keepachangelog.com/
[Semantic Versioning]: https://semver.org/