Skip to content

Commit 8451b57

Browse files
chore: update release process md
1 parent d063b88 commit 8451b57

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

.github/ISSUE_TEMPLATE/prepare_beta_release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ All items below are to be completed by the owner of the given release.
5353
- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
5454
- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
5555
- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
56-
- [Fleet](https://fleets.waku.org/)
56+
- [Fleets](https://fleets.waku.org/)
5757
- [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab)

docs/contributors/release-process.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,13 @@ For more context, see https://trunkbaseddevelopment.com/branch-for-release/
7575
> We need additional report like [this](https://www.notion.so/DST-Reports-1228f96fb65c80729cd1d98a7496fe6f) specificly from DST team.
7676
7777
6b. **Waku fleet testing**
78-
- Lock `waku.test` and `waku.sandbox` fleet to release candidate version
79-
- Analyze kibana logs for possible crashes or errors in `waku.test` and `waku.sandbox`. ( 2-3 day for beta release and 6-7 day for full release)
80-
- Most relevant logs are `(fleet: "waku.test" AND message: "SIGSEGV")` OR `(fleet: "waku.sandbox" AND message: "SIGSEGV")`
81-
- Run release candidate with `waku-simulator`, ensure that nodes connected to each other
82-
- Unlock `waku.test` to resume auto-deployment of latest `master` commit
78+
- Start job on `waku.sandbox` and `waku.test` [ Deployment job ](https://ci.infra.status.im/job/nim-waku/), Wait for completion of the job. If it fails, then debug it.
79+
- Then lock both fleets to the release candidate version. (If you don't have access to lock fleets, ask the infra team to do it.)
80+
- Verify at https://fleets.waku.org/ that the fleet is locked to the release candidate version.
81+
- Check if the image is created at [harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab)
82+
- Search _Kibana_ logs from the previous month (since the last release was deployed) for possible crashes or errors in `waku.test` and `waku.sandbox`.
83+
- Most relevant logs are `(fleet: "waku.test" AND message: "SIGSEGV")` OR `(fleet: "waku.sandbox" AND message: "SIGSEGV")`
84+
- Unlock `waku.test` and `waku.sandbox` to resume auto-deployment of the latest `master` commit
8385
8486
6c. **Status fleet testing**
8587
- Deploy release candidate to `status.staging`
@@ -122,18 +124,6 @@ We also need to merge the release branch back into master as a final step.
122124
> - `IMAGE_NAME`: `wakuorg/nwaku`
123125
> - `NIMFLAGS`: `--colors:off -d:disableMarchNative -d:chronicles_colors:none -d:postgres`
124126
> - `GIT_REF` the release tag (e.g. `v0.36.0`)
125-
3. Bump the nwaku dependency in [nwaku-compose](https://github.com/waku-org/nwaku-compose/blob/master/docker-compose.yml)
126-
4. Deploy the release to appropriate fleets:
127-
- Inform clients
128-
> **NOTE:** known clients are currently using some version of js-waku, go-waku, nwaku or waku-rs.
129-
> Clients are reachable via the corresponding channels on the Vac Discord server.
130-
> It should be enough to inform clients on the `#nwaku` and `#announce` channels on Discord.
131-
> Informal conversations with specific repo maintainers are often part of this process.
132-
- Check if nwaku configuration parameters changed. If so [update fleet configuration](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64) in [infra-nim-waku](https://github.com/status-im/infra-nim-waku)
133-
- Deploy release to the `waku.sandbox` fleet from [Jenkins](https://ci.infra.status.im/job/nim-waku/job/deploy-waku-sandbox/).
134-
- Ensure that nodes successfully start up and monitor health using [Grafana](https://grafana.infra.status.im/d/qrp_ZCTGz/nim-waku-v2?orgId=1) and [Kibana](https://kibana.infra.status.im/goto/a7728e70-eb26-11ec-81d1-210eb3022c76).
135-
- If necessary, revert by deploying the previous release. Download logs and open a bug report issue.
136-
5. Submit a PR to merge the release branch back to `master`. Make sure you use the option `Merge pull request (Create a merge commit)` to perform such merge.
137127
138128
### Performing a patch release
139129
@@ -155,3 +145,13 @@ We also need to merge the release branch back into master as a final step.
155145
4. Once the release-candidate has been validated and changelog PR got merged, cherry-pick the changelog update from master to the release branch. Create a final release tag and push it.
156146
157147
5. Create a [GitHub release](https://github.com/waku-org/nwaku/releases) from the release tag and follow the same post-release process as usual.
148+
149+
### Links
150+
151+
- [Release process](https://github.com/waku-org/nwaku/blob/master/docs/contributors/release-process.md)
152+
- [Release notes](https://github.com/waku-org/nwaku/blob/master/CHANGELOG.md)
153+
- [Fleet ownership](https://www.notion.so/Fleet-Ownership-7532aad8896d46599abac3c274189741?pvs=4#d2d2f0fe4b3c429fbd860a1d64f89a64)
154+
- [Infra-nim-waku](https://github.com/status-im/infra-nim-waku)
155+
- [Jenkins](https://ci.infra.status.im/job/nim-waku/)
156+
- [Fleet](https://fleets.waku.org/)
157+
- [Harbor](https://harbor.status.im/harbor/projects/9/repositories/nwaku/artifacts-tab)

0 commit comments

Comments
 (0)