forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
df2e0bf
commit 3a1ee08
Showing
2 changed files
with
24 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,45 @@ | ||
# sdkch | ||
# clog | ||
|
||
Simple tool to maintain modular changelogs | ||
|
||
# Usage | ||
|
||
``` | ||
$ sdkch -help | ||
usage: sdkch [-d directory] [-prune] command | ||
Maintain unreleased changelog entries in a modular fashion. | ||
Commands: | ||
add section stanza [message] Add an entry file. | ||
If message is empty, start the editor to edit | ||
the message. | ||
generate [version] Generate a changelog in Markdown format and print | ||
it to STDOUT. version defaults to UNRELEASED. | ||
Sections Stanzas | ||
--- --- | ||
breaking gaia | ||
features gaiacli | ||
improvements gaiarest | ||
bugfixes sdk | ||
tendermint | ||
Flags: | ||
-d string | ||
entry files directory (default "/home/alessio/work/tendermint/src/github.com/cosmos/cosmos-sdk/.pending") | ||
-prune | ||
prune old entries after changelog generation | ||
$ 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: | ||
|
||
```bash | ||
$ sdkch add features gaiacli '#3452 New cool gaiacli 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 | ||
|
||
```bash | ||
$ sdkch generate v0.30.0 | ||
$ clog generate v0.30.0 | ||
``` | ||
|
||
The `-prune` flag would remove the old entry files after the changelog is generated. |