From f6edd14385db162222137eca0700c8d780429feb Mon Sep 17 00:00:00 2001 From: Alexander Bezobchuk Date: Tue, 13 Aug 2019 14:40:30 -0400 Subject: [PATCH] Merge PR #101: v1.0.0 Changelog Updates --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .../breaking/gaiacli/3715-query-distr-rew | 2 - .../breaking/gaiacli/40-rest-server-s---c | 1 - .../breaking/gaiacli/4027-gaiad-and-gaiac | 1 - .../breaking/gaiacli/4142-Turn-gaiacli-tx | 2 - .../4228-merge-gaiakeyutil-into-gaiacli | 2 - .pending/breaking/gaiad/3985-ValidatorPowerR | 1 - .pending/breaking/gaiad/4027-gaiad-and-gaiac | 2 - .pending/breaking/gaiad/4159-use-module-patt | 1 - .pending/breaking/gaiad/4272-Merge-gaiarepla | 2 - .pending/breaking/rest/3715-Update-distribu | 3 - .pending/breaking/rest/3942-Support-query-t | 1 - .pending/breaking/rest/4049-update-tag | 1 - .pending/breaking/rest/The-auth-accounts-ad | 2 - .../bugfixes/gaiacli/3945-There-s-no-chec | 1 - .../bugfixes/gaiacli/4190-Fix-redelegatio | 1 - .../bugfixes/gaiacli/4219-Empty-mnemonic- | 1 - .../gaiacli/4345-Improved-NanoX-detection | 1 - .pending/bugfixes/gaiad/4113-Fix-incorrect-G | 1 - .pending/features/gaiad/Add-migrate-command- | 2 - .pending/features/gaiad/Update-Gaia-for-comm | 1 - .../3426-remove-redundant-account-check | 1 - .../gaiacli/4227-Support-for-Ledger-App-1.5 | 1 - .../improvements/gaiad/4042-Add-description | 1 - .../improvements/gaiad/4062-Remove-cmd-gaia | 1 - .../improvements/gaiad/4064-Remove-dep-and- | 1 - .../improvements/gaiad/4080-add-missing-inv | 1 - .../improvements/gaiad/4343-Upgrade-toolcha | 1 - ...07-Return-200-status-code-on-empty-results | 1 - .../improvements/rest/4123-Fix-typo-url-er | 1 - .../improvements/rest/4129-Translate-doc-c | 1 - .../improvements/rest/4141-Fix-txs-encode- | 1 - CHANGELOG.md | 85 +++++++++++++++++++ CONTRIBUTING.md | 48 ++++++----- contrib/devtools/Makefile | 6 +- 35 files changed, 115 insertions(+), 66 deletions(-) delete mode 100644 .pending/breaking/gaiacli/3715-query-distr-rew delete mode 100644 .pending/breaking/gaiacli/40-rest-server-s---c delete mode 100644 .pending/breaking/gaiacli/4027-gaiad-and-gaiac delete mode 100644 .pending/breaking/gaiacli/4142-Turn-gaiacli-tx delete mode 100644 .pending/breaking/gaiacli/4228-merge-gaiakeyutil-into-gaiacli delete mode 100644 .pending/breaking/gaiad/3985-ValidatorPowerR delete mode 100644 .pending/breaking/gaiad/4027-gaiad-and-gaiac delete mode 100644 .pending/breaking/gaiad/4159-use-module-patt delete mode 100644 .pending/breaking/gaiad/4272-Merge-gaiarepla delete mode 100644 .pending/breaking/rest/3715-Update-distribu delete mode 100644 .pending/breaking/rest/3942-Support-query-t delete mode 100644 .pending/breaking/rest/4049-update-tag delete mode 100644 .pending/breaking/rest/The-auth-accounts-ad delete mode 100644 .pending/bugfixes/gaiacli/3945-There-s-no-chec delete mode 100644 .pending/bugfixes/gaiacli/4190-Fix-redelegatio delete mode 100644 .pending/bugfixes/gaiacli/4219-Empty-mnemonic- delete mode 100644 .pending/bugfixes/gaiacli/4345-Improved-NanoX-detection delete mode 100644 .pending/bugfixes/gaiad/4113-Fix-incorrect-G delete mode 100644 .pending/features/gaiad/Add-migrate-command- delete mode 100644 .pending/features/gaiad/Update-Gaia-for-comm delete mode 100644 .pending/improvements/gaiacli/3426-remove-redundant-account-check delete mode 100644 .pending/improvements/gaiacli/4227-Support-for-Ledger-App-1.5 delete mode 100644 .pending/improvements/gaiad/4042-Add-description delete mode 100644 .pending/improvements/gaiad/4062-Remove-cmd-gaia delete mode 100644 .pending/improvements/gaiad/4064-Remove-dep-and- delete mode 100644 .pending/improvements/gaiad/4080-add-missing-inv delete mode 100644 .pending/improvements/gaiad/4343-Upgrade-toolcha delete mode 100644 .pending/improvements/rest/2007-Return-200-status-code-on-empty-results delete mode 100644 .pending/improvements/rest/4123-Fix-typo-url-er delete mode 100644 .pending/improvements/rest/4129-Translate-doc-c delete mode 100644 .pending/improvements/rest/4141-Fix-txs-encode- create mode 100644 CHANGELOG.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 162c727..24eb3aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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: `clog add [section] [stanza] [message]` +- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [ ] Reviewed `Files changed` in the github PR explorer ______ diff --git a/.pending/breaking/gaiacli/3715-query-distr-rew b/.pending/breaking/gaiacli/3715-query-distr-rew deleted file mode 100644 index 5303400..0000000 --- a/.pending/breaking/gaiacli/3715-query-distr-rew +++ /dev/null @@ -1,2 +0,0 @@ -#3715 query distr rewards returns per-validator -rewards along with rewards total amount. diff --git a/.pending/breaking/gaiacli/40-rest-server-s---c b/.pending/breaking/gaiacli/40-rest-server-s---c deleted file mode 100644 index 8ea8de2..0000000 --- a/.pending/breaking/gaiacli/40-rest-server-s---c +++ /dev/null @@ -1 +0,0 @@ -#40 rest-server's --cors option is now gone. diff --git a/.pending/breaking/gaiacli/4027-gaiad-and-gaiac b/.pending/breaking/gaiacli/4027-gaiad-and-gaiac deleted file mode 100644 index cd97354..0000000 --- a/.pending/breaking/gaiacli/4027-gaiad-and-gaiac +++ /dev/null @@ -1 +0,0 @@ -#4027 gaiacli version command dooes not return the checksum of the go.sum file anymore. diff --git a/.pending/breaking/gaiacli/4142-Turn-gaiacli-tx b/.pending/breaking/gaiacli/4142-Turn-gaiacli-tx deleted file mode 100644 index ed4c73b..0000000 --- a/.pending/breaking/gaiacli/4142-Turn-gaiacli-tx +++ /dev/null @@ -1,2 +0,0 @@ -#4142 Turn gaiacli tx send's --from into a required argument. -New shorter syntax: `gaiacli tx send FROM TO AMOUNT` diff --git a/.pending/breaking/gaiacli/4228-merge-gaiakeyutil-into-gaiacli b/.pending/breaking/gaiacli/4228-merge-gaiakeyutil-into-gaiacli deleted file mode 100644 index e986900..0000000 --- a/.pending/breaking/gaiacli/4228-merge-gaiakeyutil-into-gaiacli +++ /dev/null @@ -1,2 +0,0 @@ -#4228 Merge gaiakeyutil functionality into gaiacli keys. -Drop `gaiakeyutil` in favor of new `gaiacli keys parse` command. Syntax and semantic are preserved. diff --git a/.pending/breaking/gaiad/3985-ValidatorPowerR b/.pending/breaking/gaiad/3985-ValidatorPowerR deleted file mode 100644 index 99cc8f5..0000000 --- a/.pending/breaking/gaiad/3985-ValidatorPowerR +++ /dev/null @@ -1 +0,0 @@ -#3985 ValidatorPowerRank uses potential consensus power \ No newline at end of file diff --git a/.pending/breaking/gaiad/4027-gaiad-and-gaiac b/.pending/breaking/gaiad/4027-gaiad-and-gaiac deleted file mode 100644 index e31db9b..0000000 --- a/.pending/breaking/gaiad/4027-gaiad-and-gaiac +++ /dev/null @@ -1,2 +0,0 @@ -#4027 gaiad version command does not return the checksum of the go.sum file shipped along with the source release tarball. -Go modules feature guarantees dependencies reproducibility and as long as binaries are built via the Makefile shipped with the sources, no dependendencies can break such guarantee. diff --git a/.pending/breaking/gaiad/4159-use-module-patt b/.pending/breaking/gaiad/4159-use-module-patt deleted file mode 100644 index 1a3d439..0000000 --- a/.pending/breaking/gaiad/4159-use-module-patt +++ /dev/null @@ -1 +0,0 @@ -#4159 use module pattern and module manager for initialization \ No newline at end of file diff --git a/.pending/breaking/gaiad/4272-Merge-gaiarepla b/.pending/breaking/gaiad/4272-Merge-gaiarepla deleted file mode 100644 index 5aecf7b..0000000 --- a/.pending/breaking/gaiad/4272-Merge-gaiarepla +++ /dev/null @@ -1,2 +0,0 @@ -#4272 Merge gaiareplay functionality into gaiad replay. -Drop `gaiareplay` in favor of new `gaiad replay` command. diff --git a/.pending/breaking/rest/3715-Update-distribu b/.pending/breaking/rest/3715-Update-distribu deleted file mode 100644 index 1c562ef..0000000 --- a/.pending/breaking/rest/3715-Update-distribu +++ /dev/null @@ -1,3 +0,0 @@ -#3715 Update /distribution/delegators/{delegatorAddr}/rewards GET endpoint -as per new specs. For a given delegation, the endpoint now returns the -comprehensive list of validator-reward tuples along with the grand total. diff --git a/.pending/breaking/rest/3942-Support-query-t b/.pending/breaking/rest/3942-Support-query-t deleted file mode 100644 index a5ab311..0000000 --- a/.pending/breaking/rest/3942-Support-query-t +++ /dev/null @@ -1 +0,0 @@ -#3942 Update pagination data in txs query. diff --git a/.pending/breaking/rest/4049-update-tag b/.pending/breaking/rest/4049-update-tag deleted file mode 100644 index 6a200b7..0000000 --- a/.pending/breaking/rest/4049-update-tag +++ /dev/null @@ -1 +0,0 @@ -#4049 update tag MsgWithdrawValidatorCommission to match type \ No newline at end of file diff --git a/.pending/breaking/rest/The-auth-accounts-ad b/.pending/breaking/rest/The-auth-accounts-ad deleted file mode 100644 index 32b88a5..0000000 --- a/.pending/breaking/rest/The-auth-accounts-ad +++ /dev/null @@ -1,2 +0,0 @@ -The `/auth/accounts/{address}` now returns a `height` in the response. The -account is now nested under `account`. diff --git a/.pending/bugfixes/gaiacli/3945-There-s-no-chec b/.pending/bugfixes/gaiacli/3945-There-s-no-chec deleted file mode 100644 index e8ab060..0000000 --- a/.pending/bugfixes/gaiacli/3945-There-s-no-chec +++ /dev/null @@ -1 +0,0 @@ -#3945 There's no check for chain-id in TxBuilder.SignStdTx \ No newline at end of file diff --git a/.pending/bugfixes/gaiacli/4190-Fix-redelegatio b/.pending/bugfixes/gaiacli/4190-Fix-redelegatio deleted file mode 100644 index c9106a0..0000000 --- a/.pending/bugfixes/gaiacli/4190-Fix-redelegatio +++ /dev/null @@ -1 +0,0 @@ -#4190 Fix redelegations-from by using the correct params and query endpoint. diff --git a/.pending/bugfixes/gaiacli/4219-Empty-mnemonic- b/.pending/bugfixes/gaiacli/4219-Empty-mnemonic- deleted file mode 100644 index c050964..0000000 --- a/.pending/bugfixes/gaiacli/4219-Empty-mnemonic- +++ /dev/null @@ -1 +0,0 @@ -#4219 Return an error when an empty mnemonic is provided during key recovery. diff --git a/.pending/bugfixes/gaiacli/4345-Improved-NanoX-detection b/.pending/bugfixes/gaiacli/4345-Improved-NanoX-detection deleted file mode 100644 index 98c5fa5..0000000 --- a/.pending/bugfixes/gaiacli/4345-Improved-NanoX-detection +++ /dev/null @@ -1 +0,0 @@ -#4345 Improved Ledger Nano X detection diff --git a/.pending/bugfixes/gaiad/4113-Fix-incorrect-G b/.pending/bugfixes/gaiad/4113-Fix-incorrect-G deleted file mode 100644 index 2a5d168..0000000 --- a/.pending/bugfixes/gaiad/4113-Fix-incorrect-G +++ /dev/null @@ -1 +0,0 @@ -#4113 Fix incorrect `$GOBIN` in `Install Go` \ No newline at end of file diff --git a/.pending/features/gaiad/Add-migrate-command- b/.pending/features/gaiad/Add-migrate-command- deleted file mode 100644 index 4a2bc19..0000000 --- a/.pending/features/gaiad/Add-migrate-command- +++ /dev/null @@ -1,2 +0,0 @@ -Add `migrate` command to `gaiad` to provide the ability to migrate exported -genesis state from one version to another. diff --git a/.pending/features/gaiad/Update-Gaia-for-comm b/.pending/features/gaiad/Update-Gaia-for-comm deleted file mode 100644 index 95e1ec1..0000000 --- a/.pending/features/gaiad/Update-Gaia-for-comm +++ /dev/null @@ -1 +0,0 @@ -Update Gaia for community pool spend proposals per Cosmos Hub governance proposal #7 "Activate the Community Pool" \ No newline at end of file diff --git a/.pending/improvements/gaiacli/3426-remove-redundant-account-check b/.pending/improvements/gaiacli/3426-remove-redundant-account-check deleted file mode 100644 index adf96e7..0000000 --- a/.pending/improvements/gaiacli/3426-remove-redundant-account-check +++ /dev/null @@ -1 +0,0 @@ -#4068 Remove redundant account check on `gaiacli` diff --git a/.pending/improvements/gaiacli/4227-Support-for-Ledger-App-1.5 b/.pending/improvements/gaiacli/4227-Support-for-Ledger-App-1.5 deleted file mode 100644 index 97bc1e8..0000000 --- a/.pending/improvements/gaiacli/4227-Support-for-Ledger-App-1.5 +++ /dev/null @@ -1 +0,0 @@ -#4227 Support for Ledger App v1.5 diff --git a/.pending/improvements/gaiad/4042-Add-description b/.pending/improvements/gaiad/4042-Add-description deleted file mode 100644 index 03ed9cc..0000000 --- a/.pending/improvements/gaiad/4042-Add-description +++ /dev/null @@ -1 +0,0 @@ -#4042 Update docs and scripts to include the correct `GO111MODULE=on` environment variable. diff --git a/.pending/improvements/gaiad/4062-Remove-cmd-gaia b/.pending/improvements/gaiad/4062-Remove-cmd-gaia deleted file mode 100644 index b0d5e7c..0000000 --- a/.pending/improvements/gaiad/4062-Remove-cmd-gaia +++ /dev/null @@ -1 +0,0 @@ -#4066 Fix 'ExportGenesisFile() incorrectly overwrites genesis' diff --git a/.pending/improvements/gaiad/4064-Remove-dep-and- b/.pending/improvements/gaiad/4064-Remove-dep-and- deleted file mode 100644 index 2a219ea..0000000 --- a/.pending/improvements/gaiad/4064-Remove-dep-and- +++ /dev/null @@ -1 +0,0 @@ -#4064 Remove `dep` and `vendor` from `doc` and `version`. diff --git a/.pending/improvements/gaiad/4080-add-missing-inv b/.pending/improvements/gaiad/4080-add-missing-inv deleted file mode 100644 index 48c8172..0000000 --- a/.pending/improvements/gaiad/4080-add-missing-inv +++ /dev/null @@ -1 +0,0 @@ -#4080 add missing invariants during simulations \ No newline at end of file diff --git a/.pending/improvements/gaiad/4343-Upgrade-toolcha b/.pending/improvements/gaiad/4343-Upgrade-toolcha deleted file mode 100644 index 484d522..0000000 --- a/.pending/improvements/gaiad/4343-Upgrade-toolcha +++ /dev/null @@ -1 +0,0 @@ -#4343 Upgrade toolchain to Go 1.12.5. diff --git a/.pending/improvements/rest/2007-Return-200-status-code-on-empty-results b/.pending/improvements/rest/2007-Return-200-status-code-on-empty-results deleted file mode 100644 index af20022..0000000 --- a/.pending/improvements/rest/2007-Return-200-status-code-on-empty-results +++ /dev/null @@ -1 +0,0 @@ -#2007 Return 200 status code on empty results diff --git a/.pending/improvements/rest/4123-Fix-typo-url-er b/.pending/improvements/rest/4123-Fix-typo-url-er deleted file mode 100644 index 8f25a8f..0000000 --- a/.pending/improvements/rest/4123-Fix-typo-url-er +++ /dev/null @@ -1 +0,0 @@ -#4123 Fix typo, url error and outdated command description of doc clients. \ No newline at end of file diff --git a/.pending/improvements/rest/4129-Translate-doc-c b/.pending/improvements/rest/4129-Translate-doc-c deleted file mode 100644 index ab27102..0000000 --- a/.pending/improvements/rest/4129-Translate-doc-c +++ /dev/null @@ -1 +0,0 @@ -#4129 Translate doc clients to chinese. \ No newline at end of file diff --git a/.pending/improvements/rest/4141-Fix-txs-encode- b/.pending/improvements/rest/4141-Fix-txs-encode- deleted file mode 100644 index 0c19a16..0000000 --- a/.pending/improvements/rest/4141-Fix-txs-encode- +++ /dev/null @@ -1 +0,0 @@ -#4141 Fix /txs/encode endpoint \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9106cbb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,85 @@ + + +# Changelog + +## [Unreleased] + +## [1.0.0] - 2019-08-13 + +### Bug Fixes + +* (gaiad) [\#4113](https://github.com/cosmos/cosmos-sdk/issues/4113) Fix incorrect `$GOBIN` in `Install Go` +* (gaiacli) [\#3945](https://github.com/cosmos/cosmos-sdk/issues/3945) There's no check for chain-id in TxBuilder.SignStdTx +* (gaiacli) [\#4190](https://github.com/cosmos/cosmos-sdk/issues/4190) Fix redelegations-from by using the correct params and query endpoint. +* (gaiacli) [\#4219](https://github.com/cosmos/cosmos-sdk/issues/4219) Return an error when an empty mnemonic is provided during key recovery. +* (gaiacli) [\#4345](https://github.com/cosmos/cosmos-sdk/issues/4345) Improved Ledger Nano X detection + +### Breaking Changes + +* (sdk) Update SDK version to v0.36.0 +* (gaiad) [\#3985](https://github.com/cosmos/cosmos-sdk/issues/3985) ValidatorPowerRank uses potential consensus power +* (gaiad) [\#4027](https://github.com/cosmos/cosmos-sdk/issues/4027) gaiad version command does not return the checksum of the go.sum file shipped along with the source release tarball. + Go modules feature guarantees dependencies reproducibility and as long as binaries are built via the Makefile shipped with the sources, no dependendencies can break such guarantee. +* (gaiad) [\#4159](https://github.com/cosmos/cosmos-sdk/issues/4159) use module pattern and module manager for initialization +* (gaiad) [\#4272](https://github.com/cosmos/cosmos-sdk/issues/4272) Merge gaiareplay functionality into gaiad replay. + Drop `gaiareplay` in favor of new `gaiad replay` command. +* (gaiacli) [\#3715](https://github.com/cosmos/cosmos-sdk/issues/3715) query distr rewards returns per-validator + rewards along with rewards total amount. +* (gaiacli) [\#40](https://github.com/cosmos/cosmos-sdk/issues/40) rest-server's --cors option is now gone. +* (gaiacli) [\#4027](https://github.com/cosmos/cosmos-sdk/issues/4027) gaiacli version command dooes not return the checksum of the go.sum file anymore. +* (gaiacli) [\#4142](https://github.com/cosmos/cosmos-sdk/issues/4142) Turn gaiacli tx send's --from into a required argument. + New shorter syntax: `gaiacli tx send FROM TO AMOUNT` +* (gaiacli) [\#4228](https://github.com/cosmos/cosmos-sdk/issues/4228) Merge gaiakeyutil functionality into gaiacli keys. + Drop `gaiakeyutil` in favor of new `gaiacli keys parse` command. Syntax and semantic are preserved. +* (rest) [\#3715](https://github.com/cosmos/cosmos-sdk/issues/3715) Update /distribution/delegators/{delegatorAddr}/rewards GET endpoint + as per new specs. For a given delegation, the endpoint now returns the + comprehensive list of validator-reward tuples along with the grand total. +* (rest) [\#3942](https://github.com/cosmos/cosmos-sdk/issues/3942) Update pagination data in txs query. +* (rest) [\#4049](https://github.com/cosmos/cosmos-sdk/issues/4049) update tag MsgWithdrawValidatorCommission to match type +* (rest) The `/auth/accounts/{address}` now returns a `height` in the response. The + account is now nested under `account`. + +### Features + +* (gaiad) Add `migrate` command to `gaiad` to provide the ability to migrate exported + genesis state from one version to another. +* (gaiad) Update Gaia for community pool spend proposals per Cosmos Hub governance proposal [\#7](https://github.com/cosmos/cosmos-sdk/issues/7) "Activate the Community Pool" + +### Improvements + +* (gaiad) [\#4042](https://github.com/cosmos/cosmos-sdk/issues/4042) Update docs and scripts to include the correct `GO111MODULE=on` environment variable. +* (gaiad) [\#4066](https://github.com/cosmos/cosmos-sdk/issues/4066) Fix 'ExportGenesisFile() incorrectly overwrites genesis' +* (gaiad) [\#4064](https://github.com/cosmos/cosmos-sdk/issues/4064) Remove `dep` and `vendor` from `doc` and `version`. +* (gaiad) [\#4080](https://github.com/cosmos/cosmos-sdk/issues/4080) add missing invariants during simulations +* (gaiad) [\#4343](https://github.com/cosmos/cosmos-sdk/issues/4343) Upgrade toolchain to Go 1.12.5. +* (gaiacli) [\#4068](https://github.com/cosmos/cosmos-sdk/issues/4068) Remove redundant account check on `gaiacli` +* (gaiacli) [\#4227](https://github.com/cosmos/cosmos-sdk/issues/4227) Support for Ledger App v1.5 +* (rest) [\#2007](https://github.com/cosmos/cosmos-sdk/issues/2007) Return 200 status code on empty results +* (rest) [\#4123](https://github.com/cosmos/cosmos-sdk/issues/4123) Fix typo, url error and outdated command description of doc clients. +* (rest) [\#4129](https://github.com/cosmos/cosmos-sdk/issues/4129) Translate doc clients to chinese. +* (rest) [\#4141](https://github.com/cosmos/cosmos-sdk/issues/4141) Fix /txs/encode endpoint + + + +[Unreleased]: https://github.com/cosmos/gaia/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/cosmos/gaia/releases/tag/v1.0.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 410845f..7b8e818 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,18 @@ # Contributing -* [Pull Requests](#pull-requests) - * [Process for reviewing PRs](#process-for-reviewing-prs) - * [Updating Documentation](#updating-documentation) -* [Forking](#forking) -* [Dependencies](#dependencies) -* [Testing](#testing) -* [Branching Model and Release](#branching-model-and-release) - * [PR Targeting](#pr-targeting) - * [Development Procedure](#development-procedure) - * [Pull Merge Procedure](#pull-merge-procedure) - * [Release Procedure](#release-procedure) - * [Point Release Procedure](#point-release-procedure) +- [Contributing](#contributing) + - [Pull Requests](#pull-requests) + - [Process for reviewing PRs](#process-for-reviewing-prs) + - [Updating Documentation](#updating-documentation) + - [Forking](#forking) + - [Dependencies](#dependencies) + - [Testing](#testing) + - [Branching Model and Release](#branching-model-and-release) + - [PR Targeting](#pr-targeting) + - [Development Procedure](#development-procedure) + - [Pull Merge Procedure](#pull-merge-procedure) + - [Release Procedure](#release-procedure) + - [Point Release Procedure](#point-release-procedure) Thank you for considering making contributions to Gaia and related repositories! @@ -182,14 +183,21 @@ only pull requests targeted directly against master. - merge pull request ### Release Procedure - - start on `master` - - create the release candidate branch `rc/v*` (going forward known as **RC**) and ensure it's protected against pushing from anyone except the release manager/coordinator. **no PRs targeting this branch should be merged unless exceptional circumstances arise** - - on the `RC` branch, use `clog` to prepare the `CHANGELOG.md` and kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks). - - if errors are found during the simulation testing, commit the fixes to `master` and create a new `RC` branch (making sure to increment the `rcN`) - - after simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch - - merge the release branch to `master` to incorporate the `CHANGELOG.md` updates - - delete the `RC` branches - + +- Start on `master` +- Create the release candidate branch `rc/v*` (going forward known as **RC**) + and ensure it's protected against pushing from anyone except the release + manager/coordinator + - **no PRs targeting this branch should be merged unless exceptional circumstances arise** +- On the `RC` branch, prepare a new version section in the `CHANGELOG.md` and + kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks) +- If errors are found during the simulation testing, commit the fixes to `master` + and create a new `RC` branch (making sure to increment the `rcN`) +- After simulation has successfully completed, create the release branch + (`release/vX.XX.X`) from the `RC` branch +- Merge the release branch to `master` to incorporate the `CHANGELOG.md` updates +- Delete the `RC` branches + ### Point Release Procedure At the moment, only a single major release will be supported, so all point diff --git a/contrib/devtools/Makefile b/contrib/devtools/Makefile index 1050248..a5a8c5e 100644 --- a/contrib/devtools/Makefile +++ b/contrib/devtools/Makefile @@ -46,7 +46,6 @@ TOOLS_DESTDIR ?= $(GOPATH)/bin GOLANGCI_LINT = $(TOOLS_DESTDIR)/golangci-lint GOIMPORTS = $(TOOLS_DESTDIR)/goimports -CLOG = $(TOOLS_DESTDIR)/clog RUNSIM = $(TOOLS_DESTDIR)/runsim all: tools @@ -61,16 +60,13 @@ $(GOLANGCI_LINT): $(mkfile_dir)/install-golangci-lint.sh $(GOIMPORTS): go get golang.org/x/tools/cmd/goimports@v0.0.0-20190628034336-212fb13d595e -$(CLOG): - go get github.com/cosmos/tools/cmd/clog/ - $(RUNSIM): go get github.com/cosmos/tools/cmd/runsim/ golangci-lint: $(GOLANGCI_LINT) tools-clean: - rm -f $(GOIMPORTS) $(CLOG) $(GOLANGCI_LINT) + rm -f $(GOIMPORTS) $(GOLANGCI_LINT) rm -f tools-stamp .PHONY: all tools tools-clean