Generate CHNAGELOG.md with clog - linuxdeepin/developer-center GitHub Wiki

Install clog

You can get more information of clog from here: clog-cli

  1. Install rust first
curl https://sh.rustup.rs -sSf | sh
  1. Install clog
cargo install clog-cli
  1. Set up path

add this code to you .bashrc

source $HOME/.cargo/env

Config clog

add .clog.toml file to you project root:

The repository is Github URL for your project, if you want to put your project on github.

[clog]
repository = "https://github.com/linuxdeepin/dtkwidget"
from-latest-tag = true

changelog = "CHANGELOG.md"

Use clog

you can generate/update CHANGELOG.md with clog like this:

 clog -f 2.0.6 --setversion 2.0.7

2.0.6 is the change commit begin, and 2.0.7 is the change commit end.

How to write git commit

Please write you commit with angular format.

Angular Commit Message Format