History

Frank Yang 3a1ee0839e Merge PR #4221 : Change `sdkch` to `clog` in docs		2019-04-29 10:32:01 -04:00
..
main.go	Move tools to contrib (#4073 )	2019-04-09 10:41:00 +01:00
README.md	Merge PR #4221 : Change `sdkch` to `clog` in docs	2019-04-29 10:32:01 -04:00

README.md

clog

Simple tool to maintain modular changelogs

Usage

$  clog      
  Maintain unreleased changelog entries in a modular fashion.
  
  Usage:
    clog [command]
  
  Available Commands:
    add         Add an entry file.
    generate    Generate a changelog in Markdown format and print it to STDOUT. version defaults to UNRELEASED.
    help        Help about any command
    prune       Delete empty sub-directories recursively.
  
  Flags:
    -d, --entries-dir string   entry files directory (default "/Users/yangyanqing/go/src/github.com/cosmos/cosmos-sdk/.pending")
    -h, --help                 help for clog
    -v, --verbose-logging      enable verbose logging
  
  Use "clog [command] --help" for more information about a command.

Add a new entry

You can either drop a text file in the appropriate directory or use the add command:

$ clog add features gaiacli '#3452 New cool gaiacli command'

If no message is provided, a new entry file is opened in an editor is started

Generate the full changelog

$ clog generate v0.30.0

The -prune flag would remove the old entry files after the changelog is generated.