docs: new release process to include Status fleets #2825
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 | ||
|---|---|---|---|---|
|
|
@@ -14,14 +14,57 @@ For detailed info on the release process refer to https://github.com/waku-org/nw | |||
| --> | ||||
|
|
||||
| ### Items to complete | ||||
|
|
||||
| All items below are to be completed by the owner of the given release. | ||||
|
|
||||
| Note that `status.staging` refers to `shards.staging` fleet (rename is wip). | ||||
|
|
||||
| - [ ] Create release branch | ||||
| - [ ] Assign release candidate tag to the release branch HEAD. e.g. v0.30.0-rc.0 | ||||
| - [ ] Generate and edit releases notes in CHANGELOG.md | ||||
| - [ ] _End user impact_: Summarize impact of changes on Status end users (can be a comment in this issue). | ||||
| - [ ] **Validate release candidate** | ||||
|
|
||||
| - [ ] Automated testing | ||||
| - [ ] Ensures js-waku tests are green against release candidate | ||||
| - [ ] Ask Vac-QA and Vac-DST to perform available tests against release candidate | ||||
|
|
||||
| - [ ] **On Waku fleets** | ||||
| - [ ] Lock `waku.test` fleet to release candidate version | ||||
| - [ ] Continuously stress `waku.test` fleet for a week (e.g. from `wakudev`) | ||||
| - [ ] Search _Kibana_ logs from the previous month (since last release was deployed), for possible crashes or errors in `waku.test` and `waku.sandbox`. | ||||
| - Most relevant logs are `(fleet: "waku.test" OR fleet: "waku.sandbox") AND message: "SIGSEGV"` | ||||
| - [ ] Run release candidate with `waku-simulator`, ensure that nodes connected to each other | ||||
| - [ ] Unlock `waku.test` to resume auto-deployment of latest `master` commit | ||||
|
|
||||
| - [ ] **On Status fleet** | ||||
| - [ ] Deploy release candidate to `status.staging` | ||||
| - [ ] Perform [sanity check](https://www.notion.so/How-to-test-Nwaku-on-Status-12c6e4b9bf06420ca868bd199129b425) and log results as comments in this issue. | ||||
| - [ ] Connect 2 instances to `status.staging` fleet, one in relay mode, the other one in light client. | ||||
| - [ ] 1:1 Chats with each other | ||||
| - [ ] Send and receive messages in a community | ||||
| - [ ] Close one instance, send messages with second instance, reopen first instance and confirm messages sent while offline are retrieved from store | ||||
| - [ ] Perform checks based _end user impact_ | ||||
gabrielmer marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| - [ ] Ask other (Waku and Status) CCs to point their instance to `status.staging` for a week and use the app as usual. | ||||
| - [ ] Ask Status-QA to perform sanity checks (as described above) + checks based on _end user impact_; do specify the version being tested | ||||
| - [ ] Ask Status-QA or infra to run the automated Status e2e tests against `status.staging` | ||||
|
There was a problem hiding this comment. We believe this is the test suite: https://ci.infra.status.im/job/status-desktop/job/e2e/job/manual/ unclear how to run it against a specific fleet ( |
||||
| - [ ] Get other CCs sign-off: they comment on this PR "used app for a week, no problem", or problem reported, resolved and new RC | ||||
| - [ ] **Get Status-QA sign-off**. Ensuring that `status.test` update will not disturb ongoing activities. | ||||
|
|
||||
| - [ ] **Proceed with release** | ||||
|
|
||||
| - [ ] Assign a release tag to the same commit that contains the validated release-candidate tag | ||||
| - [ ] Create GitHub release | ||||
| - [ ] Deploy the release to DockerHub | ||||
| - [ ] Announce the release | ||||
| - [ ] Submit a PR from the release branch to master. Important to commit the PR with "create a merge commit" option. | ||||
|
There was a problem hiding this comment. That line is mentioned as a post-release step :)
Suggested change
|
||||
|
|
||||
| - [ ] **Promote release to fleets**. | ||||
| - [ ] Update infra config with any deprecated arguments or changed options | ||||
|
There was a problem hiding this comment. I added this to avoid bad surprises. |
||||
| - [ ] [Deploy final release to `waku.sandbox` fleet](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox) | ||||
| - [ ] [Deploy final release to `status.staging` fleet](https://ci.infra.status.im/job/nim-waku/job/deploy-shards-staging/) | ||||
| - [ ] [Deploy final release to `status.test` fleet](https://ci.infra.status.im/job/nim-waku/job/deploy-shards-test/) ([soon to be `status.prod`](https://github.com/status-im/infra-shards/issues/33)) | ||||
|
|
||||
Ivansete-status marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| - [ ] **Post release** | ||||
| - [ ] Submit a PR from the release branch to master. Important to commit the PR with "create a merge commit" option. | ||||
| - [ ] Update waku-org/nwaku-compose with the new release version. | ||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @fbarbu15 @Zorlin