Merge PR #4221: Change `sdkch` to `clog` in docs
This commit is contained in:
parent
df2e0bf178
commit
3a1ee0839e
|
@ -9,7 +9,7 @@ v If a checkbox is n/a - please still include it but + a little note why
|
|||
- [ ] Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
|
||||
- [ ] Wrote tests
|
||||
- [ ] Updated relevant documentation (`docs/`)
|
||||
- [ ] Added a relevant changelog entry: `sdkch add [section] [stanza] [message]`
|
||||
- [ ] Added a relevant changelog entry: `clog add [section] [stanza] [message]`
|
||||
- [ ] rereviewed `Files changed` in the github PR explorer
|
||||
|
||||
______
|
||||
|
|
|
@ -1,34 +1,29 @@
|
|||
# sdkch
|
||||
# clog
|
||||
|
||||
Simple tool to maintain modular changelogs
|
||||
|
||||
# Usage
|
||||
|
||||
```
|
||||
$ sdkch -help
|
||||
usage: sdkch [-d directory] [-prune] command
|
||||
$ 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.
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
## Add a new entry
|
||||
|
@ -36,7 +31,7 @@ Flags:
|
|||
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
|
||||
|
@ -44,7 +39,7 @@ 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.
|
||||
|
|
Loading…
Reference in New Issue