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

Document the release cycle #11954

Merged
merged 5 commits into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/11954.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add information on the Synapse release cycle.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
# Development
- [Contributing Guide](development/contributing_guide.md)
- [Code Style](code_style.md)
- [Release Cycle](development/releases.md)
- [Git Usage](development/git.md)
- [Testing]()
- [OpenTracing](opentracing.md)
Expand Down
33 changes: 33 additions & 0 deletions docs/development/releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Synapse Release Cycle

New releases of Synapse nominally follow a two week release cycle:

* Day 0: Synapse N - 1 is released.
* Day 7: Synapse N release candidate 1 is released.
* Days 7 - 13: Synapse N release candidates 2+ are released, if bugs are found.
* Day 14: Synapse N is released.
clokep marked this conversation as resolved.
Show resolved Hide resolved

Note that this schedule might be modified depending on the availability of the
Synapse team, e.g. releases may be skipped to avoid holidays.

## Bugfix releases

If a bug is found after release that is deemed to severe enough (by a combination
clokep marked this conversation as resolved.
Show resolved Hide resolved
of the impacted users and the impact on those users) then a bugfix release may
be issued. This may be at any point in the release cycle.

## Security releases

Security will sometimes be backported to the previous version and released
immediately before the next release candidate. An example of this might be:

* Day 0: Synapse N - 1 is released.
* Day 7: Synapse (N - 1).1 is released as Synapse N - 1 + the security fix.
* Day 7: Synapse N release candidate 1 is released (including the security fix).

Depending on the impact and complexity of security fixes, multiple fixes might
be held to be released together.

In some cases, a pre-disclosure of a security release will be issued as a notice
to Synapse operators that there is an upcoming security release. These can be
found on the [security category of the Matrix blog](https://matrix.org/blog/category/security).