You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

452 lines
21 KiB

7 years ago
7 years ago
7 years ago
7 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
  1. # Contributing
  2. Thank you for your interest in contributing to Tendermint! Before
  3. contributing, it may be helpful to understand the goal of the project. The goal
  4. of Tendermint is to develop a BFT consensus engine robust enough to
  5. support permissionless value-carrying networks. While all contributions are
  6. welcome, contributors should bear this goal in mind in deciding if they should
  7. target the main Tendermint project or a potential fork. When targeting the
  8. main Tendermint project, the following process leads to the best chance of
  9. landing changes in master.
  10. All work on the code base should be motivated by a [Github
  11. Issue](https://github.com/tendermint/tendermint/issues).
  12. [Search](https://github.com/tendermint/tendermint/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
  13. is a good place start when looking for places to contribute. If you
  14. would like to work on an issue which already exists, please indicate so
  15. by leaving a comment.
  16. All new contributions should start with a [Github
  17. Issue](https://github.com/tendermint/tendermint/issues/new/choose). The
  18. issue helps capture the problem you're trying to solve and allows for
  19. early feedback. Once the issue is created the process can proceed in different
  20. directions depending on how well defined the problem and potential
  21. solution are. If the change is simple and well understood, maintainers
  22. will indicate their support with a heartfelt emoji.
  23. If the issue would benefit from thorough discussion, maintainers may
  24. request that you create a [Request For
  25. Comment](https://github.com/tendermint/spec/tree/master/rfc). Discussion
  26. at the RFC stage will build collective understanding of the dimensions
  27. of the problems and help structure conversations around trade-offs.
  28. When the problem is well understood but the solution leads to large structural
  29. changes to the code base, these changes should be proposed in the form of an
  30. [Architectural Decision Record (ADR)](./docs/architecture/). The ADR will help
  31. build consensus on an overall strategy to ensure the code base maintains
  32. coherence in the larger context. If you are not comfortable with writing an
  33. ADR, you can open a less-formal issue and the maintainers will help you turn it
  34. into an ADR.
  35. > How to pick a number for the ADR?
  36. Find the largest existing ADR number and bump it by 1.
  37. When the problem as well as proposed solution are well understood,
  38. changes should start with a [draft
  39. pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
  40. against master. The draft signals that work is underway. When the work
  41. is ready for feedback, hitting "Ready for Review" will signal to the
  42. maintainers to take a look.
  43. ![Contributing flow](./docs/imgs/contributing.png)
  44. Each stage of the process is aimed at creating feedback cycles which align contributors and maintainers to make sure:
  45. - Contributors don’t waste their time implementing/proposing features which won’t land in master.
  46. - Maintainers have the necessary context in order to support and review contributions.
  47. ## Forking
  48. Please note that Go requires code to live under absolute paths, which complicates forking.
  49. While my fork lives at `https://github.com/ebuchman/tendermint`,
  50. the code should never exist at `$GOPATH/src/github.com/ebuchman/tendermint`.
  51. Instead, we use `git remote` to add the fork as a new remote for the original repo,
  52. `$GOPATH/src/github.com/tendermint/tendermint`, and do all the work there.
  53. For instance, to create a fork and work on a branch of it, I would:
  54. - Create the fork on GitHub, using the fork button.
  55. - Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/tendermint/tendermint`)
  56. - `git remote rename origin upstream`
  57. - `git remote add origin git@github.com:ebuchman/basecoin.git`
  58. Now `origin` refers to my fork and `upstream` refers to the Tendermint version.
  59. So I can `git push -u origin master` to update my fork, and make pull requests to tendermint from there.
  60. Of course, replace `ebuchman` with your git handle.
  61. To pull in updates from the origin repo, run
  62. - `git fetch upstream`
  63. - `git rebase upstream/master` (or whatever branch you want)
  64. ## Dependencies
  65. We use [go modules](https://github.com/golang/go/wiki/Modules) to manage dependencies.
  66. That said, the master branch of every Tendermint repository should just build
  67. with `go get`, which means they should be kept up-to-date with their
  68. dependencies so we can get away with telling people they can just `go get` our
  69. software.
  70. Since some dependencies are not under our control, a third party may break our
  71. build, in which case we can fall back on `go mod tidy`. Even for dependencies under our control, go helps us to
  72. keep multiple repos in sync as they evolve. Anything with an executable, such
  73. as apps, tools, and the core, should use dep.
  74. Run `go list -u -m all` to get a list of dependencies that may not be
  75. up-to-date.
  76. When updating dependencies, please only update the particular dependencies you
  77. need. Instead of running `go get -u=patch`, which will update anything,
  78. specify exactly the dependency you want to update, eg.
  79. `GO111MODULE=on go get -u github.com/tendermint/go-amino@master`.
  80. ## Protobuf
  81. We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along with [gogoproto](https://github.com/gogo/protobuf) to generate code for use across Tendermint Core.
  82. For linting, checking breaking changes and generating proto stubs, we use [buf](https://buf.build/). If you would like to run linting and check if the changes you have made are breaking then you will need to have docker running locally. Then the linting cmd will be `make proto-lint` and the breaking changes check will be `make proto-check-breaking`.
  83. There are two ways to generate your proto stubs.
  84. 1. Use Docker, pull an image that will generate your proto stubs with no need to install anything. `make proto-gen-docker`
  85. 2. Run `make proto-gen` after installing `buf` and `gogoproto`, you can do this by running `make protobuf`.
  86. ### Installation Instructions
  87. To install `protoc`, download an appropriate release (<https://github.com/protocolbuffers/protobuf>) and then move the provided binaries into your PATH (follow instructions in README included with the download).
  88. To install `gogoproto`, do the following:
  89. ```sh
  90. go get github.com/gogo/protobuf/gogoproto
  91. cd $GOPATH/pkg/mod/github.com/gogo/protobuf@v1.3.1 # or wherever go get installs things
  92. make install
  93. ```
  94. You should now be able to run `make proto-gen` from inside the root Tendermint directory to generate new files from proto files.
  95. ### Visual Studio Code
  96. If you are a VS Code user, you may want to add the following to your `.vscode/settings.json`:
  97. ```json
  98. {
  99. "protoc": {
  100. "options": [
  101. "--proto_path=${workspaceRoot}/proto",
  102. "--proto_path=${workspaceRoot}/third_party/proto"
  103. ]
  104. }
  105. }
  106. ```
  107. ## Changelog
  108. Every fix, improvement, feature, or breaking change should be made in a
  109. pull-request that includes an update to the `CHANGELOG_PENDING.md` file.
  110. Changelog entries should be formatted as follows:
  111. ```md
  112. - [module] \#xxx Some description about the change (@contributor)
  113. ```
  114. Here, `module` is the part of the code that changed (typically a
  115. top-level Go package), `xxx` is the pull-request number, and `contributor`
  116. is the author/s of the change.
  117. It's also acceptable for `xxx` to refer to the relevant issue number, but pull-request
  118. numbers are preferred.
  119. Note this means pull-requests should be opened first so the changelog can then
  120. be updated with the pull-request's number.
  121. There is no need to include the full link, as this will be added
  122. automatically during release. But please include the backslash and pound, eg. `\#2313`.
  123. Changelog entries should be ordered alphabetically according to the
  124. `module`, and numerically according to the pull-request number.
  125. Changes with multiple classifications should be doubly included (eg. a bug fix
  126. that is also a breaking change should be recorded under both).
  127. Breaking changes are further subdivided according to the APIs/users they impact.
  128. Any change that effects multiple APIs/users should be recorded multiply - for
  129. instance, a change to the `Blockchain Protocol` that removes a field from the
  130. header should also be recorded under `CLI/RPC/Config` since the field will be
  131. removed from the header in RPC responses as well.
  132. ## Branching Model and Release
  133. The main development branch is master.
  134. Every release is maintained in a release branch named `vX.Y.Z`.
  135. Pending minor releases have long-lived release candidate ("RC") branches. Minor release changes should be merged to these long-lived RC branches at the same time that the changes are merged to master.
  136. Note all pull requests should be squash merged except for merging to a release branch (named `vX.Y`). This keeps the commit history clean and makes it
  137. easy to reference the pull request where a change was introduced.
  138. ### Development Procedure
  139. The latest state of development is on `master`, which must never fail `make test`. _Never_ force push `master`, unless fixing broken git history (which we rarely do anyways).
  140. To begin contributing, create a development branch either on `github.com/tendermint/tendermint`, or your fork (using `git remote add origin`).
  141. Make changes, and before submitting a pull request, update the `CHANGELOG_PENDING.md` to record your change. Also, run either `git rebase` or `git merge` on top of the latest `master`. (Since pull requests are squash-merged, either is fine!)
  142. Update the `UPGRADING.md` if the change you've made is breaking and the
  143. instructions should be in place for a user on how he/she can upgrade it's
  144. software (ABCI application, Tendermint-based blockchain, light client, wallet).
  145. Once you have submitted a pull request label the pull request with either `R:minor`, if the change should be included in the next minor release, or `R:major`, if the change is meant for a major release.
  146. Sometimes (often!) pull requests get out-of-date with master, as other people merge different pull requests to master. It is our convention that pull request authors are responsible for updating their branches with master. (This also means that you shouldn't update someone else's branch for them; even if it seems like you're doing them a favor, you may be interfering with their git flow in some way!)
  147. #### Merging Pull Requests
  148. It is also our convention that authors merge their own pull requests, when possible. External contributors may not have the necessary permissions to do this, in which case, a member of the core team will merge the pull request once it's been approved.
  149. Before merging a pull request:
  150. - Ensure pull branch is up-to-date with a recent `master` (GitHub won't let you merge without this!)
  151. - Run `make test` to ensure that all tests pass
  152. - [Squash](https://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git) merge pull request
  153. #### Pull Requests for Minor Releases
  154. If your change should be included in a minor release, please also open a PR against the long-lived minor release candidate branch (e.g., `rc1/v0.33.5`) _immediately after your change has been merged to master_.
  155. You can do this by cherry-picking your commit off master:
  156. ```sh
  157. $ git checkout rc1/v0.33.5
  158. $ git checkout -b {new branch name}
  159. $ git cherry-pick {commit SHA from master}
  160. # may need to fix conflicts, and then use git add and git cherry-pick --continue
  161. $ git push origin {new branch name}
  162. ```
  163. After this, you can open a PR. Please note in the PR body if there were merge conflicts so that reviewers can be sure to take a thorough look.
  164. ### Git Commit Style
  165. We follow the [Go style guide on commit messages](https://tip.golang.org/doc/contribute.html#commit_messages). Write concise commits that start with the package name and have a description that finishes the sentence "This change modifies Tendermint to...". For example,
  166. ```sh
  167. cmd/debug: execute p.Signal only when p is not nil
  168. [potentially longer description in the body]
  169. Fixes #nnnn
  170. ```
  171. Each PR should have one commit once it lands on `master`; this can be accomplished by using the "squash and merge" button on Github. Be sure to edit your commit message, though!
  172. ### Release Procedure
  173. #### Major Release
  174. This major release process assumes that this release was preceded by release candidates.
  175. If there were no release candidates, and you'd like to cut a major release directly from master, see below.
  176. 1. Start on the latest RC branch (`RCx/vX.X.0`).
  177. 2. Run integration tests.
  178. 3. Branch off of the RC branch (`git checkout -b release-prep`) and prepare the release:
  179. - "Squash" changes from the changelog entries for the RCs into a single entry,
  180. and add all changes included in `CHANGELOG_PENDING.md`.
  181. (Squashing includes both combining all entries, as well as removing or simplifying
  182. any intra-RC changes. It may also help to alphabetize the entries by package name.)
  183. - Run `python ./scripts/linkify_changelog.py CHANGELOG.md` to add links for
  184. all PRs
  185. - Ensure that UPGRADING.md is up-to-date and includes notes on any breaking changes
  186. or other upgrading flows.
  187. - Bump P2P and block protocol versions in `version.go`, if necessary
  188. - Bump ABCI protocol version in `version.go`, if necessary
  189. - Add any release notes you would like to be added to the body of the release to `release_notes.md`.
  190. 4. Open a PR with these changes against the RC branch (`RCx/vX.X.0`).
  191. 5. Once these changes are on the RC branch, branch off of the RC branch again to create a release branch:
  192. - `git checkout RCx/vX.X.0`
  193. - `git checkout -b release/vX.X.0`
  194. 6. Push a tag with prepared release details. This will trigger the actual release `vX.X.0`.
  195. - `git tag -a vX.X.0 -m 'Release vX.X.0'`
  196. - `git push origin vX.X.0`
  197. 7. Make sure that `master` is updated with the latest `CHANGELOG.md`, `CHANGELOG_PENDING.md`, and `UPGRADING.md`.
  198. 8. Create the long-lived minor release branch `RC0/vX.X.1` for the next point release on this
  199. new major release series.
  200. ##### Major Release (from `master`)
  201. 1. Start on `master`
  202. 2. Run integration tests (see `test_integrations` in Makefile)
  203. 3. Prepare release in a pull request against `master` (to be squash merged):
  204. - Copy `CHANGELOG_PENDING.md` to top of `CHANGELOG.md`; if this release
  205. had release candidates, squash all the RC updates into one
  206. - Run `python ./scripts/linkify_changelog.py CHANGELOG.md` to add links for
  207. all issues
  208. - Run `bash ./scripts/authors.sh` to get a list of authors since the latest
  209. release, and add the github aliases of external contributors to the top of
  210. the changelog. To lookup an alias from an email, try `bash ./scripts/authors.sh <email>`
  211. - Reset the `CHANGELOG_PENDING.md`
  212. - Bump P2P and block protocol versions in `version.go`, if necessary
  213. - Bump ABCI protocol version in `version.go`, if necessary
  214. - Make sure all significant breaking changes are covered in `UPGRADING.md`
  215. - Add any release notes you would like to be added to the body of the release to `release_notes.md`.
  216. 4. Push a tag with prepared release details (this will trigger the release `vX.X.0`)
  217. - `git tag -a vX.X.x -m 'Release vX.X.x'`
  218. - `git push origin vX.X.x`
  219. 5. Update the `CHANGELOG.md` file on master with the releases changelog.
  220. 6. Delete any RC branches and tags for this release (if applicable)
  221. #### Minor Release (Point Releases)
  222. Minor releases are done differently from major releases: They are built off of long-lived backport branches, rather than from master.
  223. Each release "line" (e.g. 0.34 or 0.33) has its own long-lived backport branch, and
  224. the backport branches have names like `v0.34.x` or `v0.33.x` (literally, `x`; it is not a placeholder in this case).
  225. As non-breaking changes land on `master`, they should also be backported (cherry-picked) to these backport branches.
  226. Minor releases don't have release candidates by default, although any tricky changes may merit a release candidate.
  227. To create a minor release:
  228. 1. Checkout the long-lived backport branch: `git checkout vX.X.x`
  229. 2. Run integration tests: `make test_integrations`
  230. 3. Check out a new branch and prepare the release:
  231. - Copy `CHANGELOG_PENDING.md` to top of `CHANGELOG.md`
  232. - Run `python ./scripts/linkify_changelog.py CHANGELOG.md` to add links for all issues
  233. - Run `bash ./scripts/authors.sh` to get a list of authors since the latest release, and add the GitHub aliases of external contributors to the top of the CHANGELOG. To lookup an alias from an email, try `bash ./scripts/authors.sh <email>`
  234. - Reset the `CHANGELOG_PENDING.md`
  235. - Bump the ABCI version number, if necessary.
  236. (Note that ABCI follows semver, and that ABCI versions are the only versions
  237. which can change during minor releases, and only field additions are valid minor changes.)
  238. - Add any release notes you would like to be added to the body of the release to `release_notes.md`.
  239. 4. Open a PR with these changes that will land them back on `vX.X.x`
  240. 5. Once this change has landed on the backport branch, make sure to pull it locally, then push a tag.
  241. - `git tag -a vX.X.x -m 'Release vX.X.x'`
  242. - `git push origin vX.X.x`
  243. 6. Create a pull request back to master with the CHANGELOG & version changes from the latest release.
  244. - Remove all `R:minor` labels from the pull requests that were included in the release.
  245. - Do not merge the backport branch into master.
  246. #### Release Candidates
  247. Before creating an official release, especially a major release, we may want to create a
  248. release candidate (RC) for our friends and partners to test out. We use git tags to
  249. create RCs, and we build them off of RC branches. RC branches typically have names formatted
  250. like `RCX/vX.X.X` (or, concretely, `RC0/v0.34.0`), while the tags themselves follow
  251. the "standard" release naming conventions, with `-rcX` at the end (`vX.X.X-rcX`).
  252. (Note that branches and tags _cannot_ have the same names, so it's important that these branches
  253. have distinct names from the tags/release names.)
  254. 1. Start from the RC branch (e.g. `RC0/v0.34.0`).
  255. 2. Create the new tag, specifying a name and a tag "message":
  256. `git tag -a v0.34.0-rc0 -m "Release Candidate v0.34.0-rc0`
  257. 3. Push the tag back up to origin:
  258. `git push origin v0.34.0-rc4`
  259. Now the tag should be available on the repo's releases page.
  260. 4. Create a new release candidate branch for any possible updates to the RC:
  261. `git checkout -b RC1/v0.34.0; git push origin RC1/v0.34.0`
  262. ## Testing
  263. ### Unit tests
  264. Unit tests are located in `_test.go` files as directed by [the Go testing
  265. package](https://golang.org/pkg/testing/). If you're adding or removing a
  266. function, please check there's a `TestType_Method` test for it.
  267. Run: `make test`
  268. ### Integration tests
  269. Integration tests are also located in `_test.go` files. What differentiates
  270. them is a more complicated setup, which usually involves setting up two or more
  271. components.
  272. Run: `make test_integrations`
  273. ### End-to-end tests
  274. End-to-end tests are used to verify a fully integrated Tendermint network.
  275. See [README](./test/e2e/README.md) for details.
  276. Run:
  277. ```sh
  278. cd test/e2e && \
  279. make && \
  280. ./build/runner -f networks/ci.toml
  281. ```
  282. ### Maverick
  283. **If you're changing the code in `consensus` package, please make sure to
  284. replicate all the changes in `./test/maverick/consensus`**. Maverick is a
  285. byzantine node used to assert that the validator gets punished for malicious
  286. behavior.
  287. See [README](./test/maverick/README.md) for details.
  288. ### Model-based tests (ADVANCED)
  289. *NOTE: if you're just submitting your first PR, you won't need to touch these
  290. most probably (99.9%)*.
  291. For components, that have been [formally
  292. verified](https://en.wikipedia.org/wiki/Formal_verification) using
  293. [TLA+](https://en.wikipedia.org/wiki/TLA%2B), it may be possible to generate
  294. tests using a combination of the [Apalache Model
  295. Checker](https://apalache.informal.systems/) and [tendermint-rs testgen
  296. util](https://github.com/informalsystems/tendermint-rs/tree/master/testgen).
  297. Now, I know there's a lot to take in. If you want to learn more, check out [
  298. this video](https://www.youtube.com/watch?v=aveoIMphzW8) by Andrey Kupriyanov
  299. & Igor Konnov.
  300. At the moment, we have model-based tests for the light client, located in the
  301. `./light/mbt` directory.
  302. Run: `cd light/mbt && go test`
  303. ### Fuzz tests (ADVANCED)
  304. *NOTE: if you're just submitting your first PR, you won't need to touch these
  305. most probably (99.9%)*.
  306. [Fuzz tests](https://en.wikipedia.org/wiki/Fuzzing) can be found inside the
  307. `./test/fuzz` directory. See [README.md](./test/fuzz/README.md) for details.
  308. Run: `cd test/fuzz && make fuzz-{PACKAGE-COMPONENT}`
  309. ### Jepsen tests (ADVANCED)
  310. *NOTE: if you're just submitting your first PR, you won't need to touch these
  311. most probably (99.9%)*.
  312. [Jepsen](http://jepsen.io/) tests are used to verify the
  313. [linearizability](https://jepsen.io/consistency/models/linearizable) property
  314. of the Tendermint consensus. They are located in a separate repository
  315. -> https://github.com/tendermint/jepsen. Please refer to it's README for more
  316. information.
  317. ### RPC Testing
  318. **If you contribute to the RPC endpoints it's important to document your
  319. changes in the [Openapi file](./rpc/openapi/openapi.yaml)**.
  320. To test your changes you must install `nodejs` and run:
  321. ```bash
  322. npm i -g dredd
  323. make build-linux build-contract-tests-hooks
  324. make contract-tests
  325. ```
  326. **WARNING: these are currently broken due to https://github.com/apiaryio/dredd
  327. not supporting complete OpenAPI 3**.
  328. This command will popup a network and check every endpoint against what has
  329. been documented.