From 84c614676ddb35a2a01b5a18d972388c35fb61ee Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Wed, 22 Jan 2025 09:11:35 +0000 Subject: [PATCH] Improve release documentation for staging.element.io deployments (#29038) Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- docs/release.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/release.md b/docs/release.md index b2c797b66b5..087b78f031d 100644 --- a/docs/release.md +++ b/docs/release.md @@ -8,11 +8,13 @@ #### develop -The develop branch holds the very latest and greatest code we have to offer, as such it may be less stable. It corresponds to the develop.element.io CD platform. +The develop branch holds the very latest and greatest code we have to offer, as such it may be less stable. +It is auto-deployed on every commit to element-web or matrix-js-sdk to develop.element.io via GitHub Actions `build_develop.yml`. #### staging The staging branch corresponds to the very latest release regardless of whether it is an RC or not. Deployed to staging.element.io manually. +It is auto-deployed on every release of element-web to staging.element.io via GitHub Actions `deploy.yml`. #### master @@ -215,7 +217,7 @@ We ship Element Web to dockerhub, `*.element.io`, and packages.element.io. We ship Element Desktop to packages.element.io. - [ ] Check that element-web has shipped to dockerhub -- [ ] Deploy staging.element.io. [See docs.](https://handbook.element.io/books/element-web-team/page/deploying-appstagingelementio) +- [ ] Check that the staging [deployment](https://github.com/element-hq/element-web/actions/workflows/deploy.yml) has completed successfully - [ ] Test staging.element.io For final releases additionally do these steps: @@ -225,6 +227,9 @@ For final releases additionally do these steps: - [ ] Ensure Element Web package has shipped to packages.element.io - [ ] Ensure Element Desktop packages have shipped to packages.element.io +If you need to roll back a deployment to staging.element.io, +you can run the `deploy.yml` automation choosing an older tag which you wish to deploy. + # Housekeeping We have some manual housekeeping to do in order to prepare for the next release.