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.

Sign up for GitHub

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

Update CONTRIBUTING to release workflow in CI #1283

Merged
merged 2 commits into from
Mar 7, 2023
Merged

Update CONTRIBUTING to release workflow in CI #1283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4f1a7a
Update CONTRIBUTING to release workflow in CI
mzabaluev Mar 7, 2023
0390923
CONTRIBUTING.md: insist on signed release tags
mzabaluev Mar 7, 2023
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
17 changes: 12 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,14 +186,21 @@ Our release process is as follows:
documentation compiles and seems up-to-date and coherent. Fix any potential
issues here and push them to the release PR.
5. Mark the PR as **Ready for Review** and incorporate feedback on the release.
6. Once approved, run the [`release.sh`] script. Fix any problems that may arise
during this process and push the changes to the release PR. This step
requires the appropriate privileges to push crates to [crates.io].
7. Once all crates have been successfully released, merge the PR to `main` and
tag the repo at the new version (e.g. `v0.17.0`).
6. Once approved, merge the PR to `main`, create a signed tag with the new version
(e.g. `v0.31.0`) and push the tag. The [release workflow][release.yml]
will run the [`release.sh`] script in a CI worker.
7. If some crates have not been released, check the cause of the failure and
act accordingly:
1. In case of intermittent problems with the registry, rerun the script
locally to publish any missing crates from this release.
This step requires the appropriate privileges to push crates to [crates.io].
2. In case the problems arise from the source files, fix them,
bump a new patch version (e.g. `v0.31.1`) and repeat the process
with its corresponding new tag.

[CHANGELOG.md]: https://github.com/informalsystems/tendermint-rs/blob/main/CHANGELOG.md
[`release.sh`]: https://github.com/informalsystems/tendermint-rs/blob/main/release.sh
[crates.io]: https://crates.io
[unclog]: https://github.com/informalsystems/unclog
[Tendermint]: https://tendermint.com
[release.yml]: https://github.com/informalsystems/tendermint-rs/blob/main/.github/workflows/release.yml