-
Notifications
You must be signed in to change notification settings - Fork 735
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial commit of updates * Adding new RELEASING.md file * Update contact info in COC * Adding info on tag deletion, fixed reproducible build cmd * Update .github/CODEOWNERS Co-authored-by: Alessio Treglia <alessio@tendermint.com> Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com>
- Loading branch information
3 people
authored
Feb 13, 2021
1 parent
7c4113c
commit b0312c5
Showing
5 changed files
with
220 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # CODEOWNERS: https://help.github.com/articles/about-codeowners/ | ||
|
|
||
| # Primary repo maintainers | ||
| * @alessio @alexanderbez @jgimeno @fedekunze | ||
| * @alessio @alexanderbez @jgimeno @fedekunze @shahankhatch @zmanian |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,133 @@ | ||
|
|
||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
| We as members, contributors, and leaders pledge to make participation in our | ||
| community a harassment-free experience for everyone, regardless of age, body | ||
| size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
| identity and expression, level of experience, education, socio-economic status, | ||
| nationality, personal appearance, race, religion, or sexual identity | ||
| and orientation. | ||
|
|
||
| We pledge to act and interact in ways that contribute to an open, welcoming, | ||
| diverse, inclusive, and healthy community. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment include: | ||
| Examples of behavior that contributes to a positive environment for our | ||
| community include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
| * Demonstrating empathy and kindness toward other people | ||
| * Being respectful of differing opinions, viewpoints, and experiences | ||
| * Giving and gracefully accepting constructive feedback | ||
| * Accepting responsibility and apologizing to those affected by our mistakes, | ||
| and learning from the experience | ||
| * Focusing on what is best not just for us as individuals, but for the | ||
| overall community | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * The use of sexualized language or imagery, and sexual attention or | ||
| advances of any kind | ||
| * Trolling, insulting or derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||
| * Publishing others' private information, such as a physical or email | ||
| address, without their explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ## Our Responsibilities | ||
| ## Enforcement Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
| Community leaders are responsible for clarifying and enforcing our standards of | ||
| acceptable behavior and will take appropriate and fair corrective action in | ||
| response to any behavior that they deem inappropriate, threatening, offensive, | ||
| or harmful. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
| Community leaders have the right and responsibility to remove, edit, or reject | ||
| comments, commits, code, wiki edits, issues, and other contributions that are | ||
| not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
| decisions when appropriate. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
| This Code of Conduct applies within all community spaces, and also applies when | ||
| an individual is officially representing the community in public spaces. | ||
| Examples of representing our community include using an official e-mail address, | ||
| posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at adrian@tendermint.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| `contact@interchain.berlin`. | ||
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
| reporter of any incident. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining | ||
| the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed | ||
| unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing | ||
| clarity around the nature of the violation and an explanation of why the | ||
| behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
| **Community Impact**: A violation through a single incident or series | ||
| of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No | ||
| interaction with the people involved, including unsolicited interaction with | ||
| those enforcing the Code of Conduct, for a specified period of time. This | ||
| includes avoiding interactions in community spaces as well as external channels | ||
| like social media. Violating these terms may lead to a temporary or | ||
| permanent ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including | ||
| sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public | ||
| communication with the community for a specified period of time. No public or | ||
| private interaction with the people involved, including unsolicited interaction | ||
| with those enforcing the Code of Conduct, is allowed during this period. | ||
| Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community | ||
| standards, including sustained inappropriate behavior, harassment of an | ||
| individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within | ||
| the community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 2.0, available at | ||
| [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. | ||
|
|
||
| Community Impact Guidelines were inspired by | ||
| [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at | ||
| [https://www.contributor-covenant.org/faq][FAQ]. Translations are available | ||
| at [https://www.contributor-covenant.org/translations][translations]. | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ | ||
| [homepage]: https://www.contributor-covenant.org | ||
| [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | ||
| [Mozilla CoC]: https://github.com/mozilla/diversity | ||
| [FAQ]: https://www.contributor-covenant.org/faq | ||
| [translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
|
|
||
| ### Long-Lived Version Branch Approach | ||
|
|
||
| Cherry-pick commits from `main` into the long-lived `release/vn.n.x` branch, e.g., `release/v3.0.x`. | ||
| It is fine to create a long-lived branch from main if the last commit is the release commit. | ||
|
|
||
| ### Release Procedure | ||
|
|
||
| - Start on `main` | ||
| - 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 `main` | ||
| 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 `main` 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 | ||
| releases will be based off of that release. | ||
|
|
||
| - start on `vX.XX.X` | ||
| - checkout a new branch `rcN/vX.X.X` | ||
| - cherry pick the desired changes from `main` | ||
| - these changes should be small and NON-BREAKING (both API and state machine) | ||
| - add entries to CHANGELOG.md and remove corresponding pending log entries | ||
| - checkout a new branch `release/vX.X.X` based off of the previous release | ||
| - create a PR merging `rcN/vX.X.X` into `release/vX.X.X` | ||
| - run tests and simulations (noted in [Release Procedure](#release-procedure)) | ||
| - after tests and simulation have successfully completed, merge the `RC` branch into `release/vX.X.X` | ||
| - Make sure to delete the `RC` branch | ||
| - create a PR into `main` containing ONLY the CHANGELOG.md updates | ||
| - tag (use `git tag -a`) then push the tags (`git push --tags`) | ||
|
|
||
| ### Dependency review | ||
|
|
||
| Check the `replace` line in `go.mod` of the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/blob/master/go.mod) for something like: | ||
| ``` | ||
| replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1 | ||
| ``` | ||
| Ensure that the same replace line is also used in Gaia's `go.mod` file. | ||
|
|
||
| ### Tagging | ||
|
|
||
| 1. Ensure you have checked out the commit you wish to tag | ||
| 1. `git pull --tags --dry-run` | ||
| 1. `git pull --tags` | ||
| 1. `git tag -a v3.0.1 -m 'Release v3.0.1'` | ||
| 1. optional, add the `-s` tag to create a signed commit using your PGP key (which should be added to github beforehand) | ||
| 1. `git push --tags --dry-run` | ||
| 1. `git push --tags` | ||
|
|
||
| If a tag needs to be re-created, do the following: | ||
| 1. `git tag -d v4.0.0` to delete a tag locally | ||
| 1. `git push --delete origin v4.0.0`, to push the deletion to the remote | ||
| 1. Proceed with the above steps to create a tag | ||
|
|
||
| ### Release notes | ||
|
|
||
| Ensure you run the reproducible build in order to generate sha256 hashes and platform binaries; | ||
| these artifacts should be included in the release. | ||
|
|
||
| ```bash | ||
| make distclean build-reproducable | ||
| ``` | ||
|
|
||
| Then use the following release text template: | ||
|
|
||
| ```markdown | ||
| # Gaia v4.0.0 Release Notes | ||
|
|
||
| Note, that this specific release will be updated with a newer changelog, and the below hashes and binaries will also be updated. | ||
|
|
||
| This release includes bug fixes for prop29, as well as additional support for IBC and Ledger signing. | ||
|
|
||
| As there is a breaking change from Gaia v3, the Gaia module has been incremented to v4. | ||
|
|
||
| See the [Cosmos SDK v0.41.0 Release](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.41.0) for details. | ||
|
|
||
| ```bash | ||
| $ make distclean build-reproducable | ||
| App: gaiad | ||
| Version: 4.0.0 | ||
| Commit: 2bb04266266586468271c4ab322367acbf41188f | ||
| Files: | ||
| 2e801c7424ef67e6d9fc092c2b75c2d3 gaiad-4.0.0-darwin-amd64 | ||
| dc21eb861480e0f55af876f271b512fe gaiad-4.0.0-linux-amd64 | ||
| bda165f91bc065afb8a445e72be9a868 gaiad-4.0.0-linux-arm64 | ||
| c7203d53bd596679b39b6a94d1dbe0dc gaiad-4.0.0-windows-amd64.exe | ||
| 81299b602e1760078e03c97813edda60 gaiad-4.0.0.tar.gz | ||
| Checksums-Sha256: | ||
| de764e52acc31dd98fa49d8d0eef851f3b7b53e4f1d4fbfda2c07b1a8b115b91 gaiad-4.0.0-darwin-amd64 | ||
| e5244ccd98a05479cc35753da1bb5b6bd873f6d8ebe6f8c5d112cf4d9e2761b4 gaiad-4.0.0-linux-amd64 | ||
| 7b7c4ea3e2de5f228436dcbb177455906239603b11eca1fb1015f33973d7b567 gaiad-4.0.0-linux-arm64 | ||
| b418c5f296ee6f946f44da8497af594c6ad0ece2b1da09a93a45d7d1b1457f27 gaiad-4.0.0-windows-amd64.exe | ||
| 3895518436b74be8b042d7d0b868a60d03e1656e2556b12132be0f25bcb061ef gaiad-4.0.0.tar.gz | ||
| ``` | ||
|
|