diff options
author | Erik Johnston <erik@matrix.org> | 2021-04-06 13:07:36 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-06 13:07:36 +0100 |
commit | a888cbdd314a84cbb477e5b04bd27b7053f08495 (patch) | |
tree | fd87d34a3e5c29129daa7deaf7825bc4c4a0ee0b /docs/deprecation_policy.md | |
parent | Fix version for bugbear (#9734) (diff) | |
download | synapse-a888cbdd314a84cbb477e5b04bd27b7053f08495.tar.xz |
Add deprecation policy doc (#9723)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to '')
-rw-r--r-- | docs/deprecation_policy.md | 33 |
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. |