-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add deprecation policy doc #9723
Changes from 5 commits
5853864
058f20c
fc0519f
b35de3f
acb7a7b
37a92e4
853054d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Add a document describing the deprecation policy for platform dependencies. | ||
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -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 how we | ||||||||||
drop support for versions in the future. | ||||||||||
erikjohnston marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
||||||||||
|
||||||||||
Policy | ||||||||||
------ | ||||||||||
|
||||||||||
For Python and PostgreSQL Synapse will follow the upstream support life cycles, | ||||||||||
i.e. when a version reaches End of Life Synapse will withdraw support for that | ||||||||||
version in future releases. | ||||||||||
erikjohnston marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
|
||||||||||
Details on the upstream support life cycles for Python and PostgreSQL are | ||||||||||
documented at https://endoflife.date/python and | ||||||||||
https://endoflife.date/postgresql. | ||||||||||
|
||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we not want to comment on the policy for any other dependencies? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we have other deps we care about in this regard? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably not, but it may be nice to explicitly say that we don't. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can always add more in the future. 🤷 |
||||||||||
|
||||||||||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe just: