Skip to content

Commit

Permalink
add sdkch to maintain PENDING.md effectively and free of file conflicts
Browse files Browse the repository at this point in the history
Closes: #2380
  • Loading branch information
Alessio Treglia committed Mar 12, 2019
1 parent f97e85e commit c8180a7
Show file tree
Hide file tree
Showing 11 changed files with 376 additions and 74 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3837 Fix `WithdrawValidatorCommission` to properly set the validator's remaining commission.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3813 New sdk.NewCoins safe constructor to replace bare sdk.Coins{} declarations.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3808 `gaiad` and `gaiacli` integration tests use ./build/ binaries.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3859 Add newline to echo of `gaiacli keys ...`
1 change: 1 addition & 0 deletions .pending/improvements/sdk/3801-baseapp-safety-improvements
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3801 `baseapp` safety improvements
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3820 Make Coins.IsAllGT() more robust and consistent.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3828 New sdkch tool to maintain changelogs
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ devtools-stamp: tools
@echo "--> Downloading linters (this may take awhile)"
$(GOPATH)/src/github.com/alecthomas/gometalinter/scripts/install.sh -b $(GOBIN)
go get github.com/tendermint/lint/golint
go install ./cmd/sdkch
touch $@

vendor-deps: tools
Expand Down
74 changes: 0 additions & 74 deletions PENDING.md

This file was deleted.

51 changes: 51 additions & 0 deletions cmd/sdkch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# sdkch
Simple tool to maintain modular changelogs

# Usage

```
$ sdkch -help
usage: sdkch COMMAND
Maintain unreleased changelog entries in a modular fashion.
Commands:
init
add SECTION STANZA Add an entry file.
Read from stdin until it
encounters EOF.
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 "./.pending")
```

## 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'
```

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

## Generate the full changelog

```bash
$ sdkch generate
```

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

0 comments on commit c8180a7

Please sign in to comment.