summary refs log tree commit diff
path: root/docs/deprecation_policy.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2021-04-06 13:28:54 +0100
committerErik Johnston <erik@matrix.org>2021-04-06 13:29:29 +0100
commit5688a74cf3042c0064e3600cb03f6edaa7f7c838 (patch)
treeb7dd5c333d6b6c45aa27fb79d5f67e51f3b86941 /docs/deprecation_policy.md
parentAdd type hints to the federation handler and server. (#9743) (diff)
parent 1.31.0 (diff)
downloadsynapse-5688a74cf3042c0064e3600cb03f6edaa7f7c838.tar.xz
Merge branch 'master' into develop
Diffstat (limited to '')
-rw-r--r--docs/deprecation_policy.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/deprecation_policy.md b/docs/deprecation_policy.md
new file mode 100644
index 0000000000..06ea340559
--- /dev/null
+++ b/docs/deprecation_policy.md
@@ -0,0 +1,33 @@
+Deprecation Policy for Platform Dependencies
+============================================
+
+Synapse has a number of platform dependencies, including Python and PostgreSQL.
+This document outlines the policy towards which versions we support, and when we
+drop support for versions in the future.
+
+
+Policy
+------
+
+Synapse follows the upstream support life cycles for Python and PostgreSQL,
+i.e. when a version reaches End of Life Synapse will withdraw support for that
+version in future releases.
+
+Details on the upstream support life cycles for Python and PostgreSQL are
+documented at https://endoflife.date/python and
+https://endoflife.date/postgresql.
+
+
+Context
+-------
+
+It is important for system admins to have a clear understanding of the platform
+requirements of Synapse and its deprecation policies so that they can
+effectively plan upgrading their infrastructure ahead of time. This is
+especially important in contexts where upgrading the infrastructure requires
+auditing and approval from a security team, or where otherwise upgrading is a
+long process.
+
+By following the upstream support life cycles Synapse can ensure that its
+dependencies continue to get security patches, while not requiring system admins
+to constantly update their platform dependencies to the latest versions.