conventional-changelog

Generate and update CHANGELOG file with conventional-changelog style in emacs. This package provides the interface conventional-changelog-menu, which is built with transient, between command-line tool standard-version and emacs. Call conventional-changelog-menu to start.

Deprecate: due to standard-version isn't maintained anymore, and other bugs such as couldn't identify submodules path, this package is not maintained anymore. Please use other CLI tools like git-cliff and related emacs package git-cliff.el instead.

Contents

• conventional-changelog
  • Screenshot
  • Install
    • dependencies
    • package
  • Usage
  • Feature
  • Comparison
  • Todo
  • License

Screenshot

• Implemented with transient:

• (OPTIONAL) Integrate with magit:

Install

dependencies

• standard-version

npm install -g standard-version

• (OPTIONAL) pandoc, org-mode required

# MacOS (for example)
brew install pandoc

package

• Manually

Clone and add to load-path, require the package.

• Melpa

This package is available on MELPA. Install with M-x package-install RET conventional-changelog from within Emacs.

Usage

;; Directly
(require 'conventional-changelog)
(with-eval-after-load 'magit-tag    ;; Integrate to `magit-tag'
  (transient-append-suffix 'magit-tag
    '(1 0 -1)
    '("c" "changelog" conventional-changelog-menu)))

;; Or with `use-package', etc
(use-package conventional-changelog
  :init
  (with-eval-after-load 'magit-tag
    (transient-append-suffix 'magit-tag
      '(1 0 -1)
      '("c" "changelog" conventional-changelog-menu))))

Call conventional-changelog-menu

Feature

• Totally compatible with standard-version#conf by default
• Support both CHANGELOG.md and CHANGELOG.org, selected automatically if exists in repository
• Options of --release-as and --prerelease is highly customizable
• Integration with magit

Comparison

There are some packages which generate CHANGELOG file, adheres to Semantic Versioning

el-conventional-changelog

• Not compatible with standard-version
• only support Org

markdown-changelog

• Don't follow conventional style
• Only support Markdown

Todo

• compress shell-command output
• asyc-shell-command

License

See LICENSE.