Skip to content

Commit 84c6146

Browse files
authored
Improve release documentation for staging.element.io deployments (#29038)
Signed-off-by: Michael Telatynski <[email protected]>
1 parent 29d9e98 commit 84c6146

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/release.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88
99
#### develop
1010
11-
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.
11+
The develop branch holds the very latest and greatest code we have to offer, as such it may be less stable.
12+
It is auto-deployed on every commit to element-web or matrix-js-sdk to develop.element.io via GitHub Actions `build_develop.yml`.
1213
1314
#### staging
1415
1516
The staging branch corresponds to the very latest release regardless of whether it is an RC or not. Deployed to staging.element.io manually.
17+
It is auto-deployed on every release of element-web to staging.element.io via GitHub Actions `deploy.yml`.
1618
1719
#### master
1820
@@ -215,7 +217,7 @@ We ship Element Web to dockerhub, `*.element.io`, and packages.element.io.
215217
We ship Element Desktop to packages.element.io.
216218

217219
- [ ] Check that element-web has shipped to dockerhub
218-
- [ ] Deploy staging.element.io. [See docs.](https://handbook.element.io/books/element-web-team/page/deploying-appstagingelementio)
220+
- [ ] Check that the staging [deployment](https://github.com/element-hq/element-web/actions/workflows/deploy.yml) has completed successfully
219221
- [ ] Test staging.element.io
220222

221223
For final releases additionally do these steps:
@@ -225,6 +227,9 @@ For final releases additionally do these steps:
225227
- [ ] Ensure Element Web package has shipped to packages.element.io
226228
- [ ] Ensure Element Desktop packages have shipped to packages.element.io
227229

230+
If you need to roll back a deployment to staging.element.io,
231+
you can run the `deploy.yml` automation choosing an older tag which you wish to deploy.
232+
228233
# Housekeeping
229234

230235
We have some manual housekeeping to do in order to prepare for the next release.

0 commit comments

Comments
 (0)