Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add sdkch to maintain changelog effectively and free of file conflicts #3828

Merged
merged 1 commit into from
Mar 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 entries in `PENDING.md` with issue #
- [ ] Added a relevant changelog entry: `sdkch add [section] [stanza] [message]`
- [ ] rereviewed `Files changed` in the github PR explorer

______
Expand Down
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.
1 change: 1 addition & 0 deletions .pending/improvements/gaiacli/3841-Add-indent-to-J
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3841 Add indent to JSON of `gaiacli keys [add|show|list]`
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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#3864 Make Coins.IsAllGTE() more consistent.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,16 @@ update_dev_tools:
go get -u github.com/tendermint/lint/golint

devtools: devtools-stamp
devtools-clean: tools-clean
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
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
touch $@

devtools-clean: tools-clean
rm -f devtools-stamp

vendor-deps: tools
@echo "--> Generating vendor directory via dep ensure"
@rm -rf .vendor-new
Expand Down
77 changes: 0 additions & 77 deletions PENDING.md

This file was deleted.

50 changes: 50 additions & 0 deletions cmd/sdkch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# sdkch
Simple tool to maintain modular changelogs
alessio marked this conversation as resolved.
Show resolved Hide resolved

# 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:
alessio marked this conversation as resolved.
Show resolved Hide resolved
-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

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 v0.30.0
```

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