summary refs log tree commit diff
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2022-02-10 08:15:10 -0500
committerGitHub <noreply@github.com>2022-02-10 13:15:10 +0000
commite4fdf459e24745be856efb535d539082a00da51b (patch)
tree29ddb08c0a4b5da9afdd3d60cc3eceee655a748a
parentFix example for structured logging. (#11946) (diff)
downloadsynapse-e4fdf459e24745be856efb535d539082a00da51b.tar.xz
Basic documentation for the release cycle. (#11954)
-rw-r--r--changelog.d/11954.doc1
-rw-r--r--docs/SUMMARY.md1
-rw-r--r--docs/development/releases.md37
3 files changed, 39 insertions, 0 deletions
diff --git a/changelog.d/11954.doc b/changelog.d/11954.doc
new file mode 100644
index 0000000000..6e7b390890
--- /dev/null
+++ b/changelog.d/11954.doc
@@ -0,0 +1 @@
+Add information on the Synapse release cycle.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 3eeb1a2799..ef9cabf555 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -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)
diff --git a/docs/development/releases.md b/docs/development/releases.md
new file mode 100644
index 0000000000..c9a8c69945
--- /dev/null
+++ b/docs/development/releases.md
@@ -0,0 +1,37 @@
+# Synapse Release Cycle
+
+Releases of Synapse follow a two week release cycle with new releases usually
+occurring on Tuesdays:
+
+* 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.
+
+Note that this schedule might be modified depending on the availability of the
+Synapse team, e.g. releases may be skipped to avoid holidays.
+
+Release announcements can be found in the
+[release category of the Matrix blog](https://matrix.org/blog/category/releases).
+
+## Bugfix releases
+
+If a bug is found after release that is deemed severe enough (by a combination
+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 in the [security category of the Matrix blog](https://matrix.org/blog/category/security).