Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit e4fdf45

Browse files
authored
Basic documentation for the release cycle. (#11954)
1 parent 3914576 commit e4fdf45

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed

changelog.d/11954.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add information on the Synapse release cycle.

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
# Development
8080
- [Contributing Guide](development/contributing_guide.md)
8181
- [Code Style](code_style.md)
82+
- [Release Cycle](development/releases.md)
8283
- [Git Usage](development/git.md)
8384
- [Testing]()
8485
- [OpenTracing](opentracing.md)

docs/development/releases.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Synapse Release Cycle
2+
3+
Releases of Synapse follow a two week release cycle with new releases usually
4+
occurring on Tuesdays:
5+
6+
* Day 0: Synapse `N - 1` is released.
7+
* Day 7: Synapse `N` release candidate 1 is released.
8+
* Days 7 - 13: Synapse `N` release candidates 2+ are released, if bugs are found.
9+
* Day 14: Synapse `N` is released.
10+
11+
Note that this schedule might be modified depending on the availability of the
12+
Synapse team, e.g. releases may be skipped to avoid holidays.
13+
14+
Release announcements can be found in the
15+
[release category of the Matrix blog](https://matrix.org/blog/category/releases).
16+
17+
## Bugfix releases
18+
19+
If a bug is found after release that is deemed severe enough (by a combination
20+
of the impacted users and the impact on those users) then a bugfix release may
21+
be issued. This may be at any point in the release cycle.
22+
23+
## Security releases
24+
25+
Security will sometimes be backported to the previous version and released
26+
immediately before the next release candidate. An example of this might be:
27+
28+
* Day 0: Synapse N - 1 is released.
29+
* Day 7: Synapse (N - 1).1 is released as Synapse N - 1 + the security fix.
30+
* Day 7: Synapse N release candidate 1 is released (including the security fix).
31+
32+
Depending on the impact and complexity of security fixes, multiple fixes might
33+
be held to be released together.
34+
35+
In some cases, a pre-disclosure of a security release will be issued as a notice
36+
to Synapse operators that there is an upcoming security release. These can be
37+
found in the [security category of the Matrix blog](https://matrix.org/blog/category/security).

0 commit comments

Comments
 (0)