This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Add deprecation policy doc #9723
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Add a document describing the deprecation policy for platform dependencies. | ||
|
There was a problem hiding this comment. Maybe just:
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | ||||||||||
| 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.
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
|
||||||||||
|
|
||||||||||
| The team will not intentionally break compatibility for at least one month after | ||||||||||
| an EOL date, but does explicitly reserve the right to do so should security or | ||||||||||
| other concerns arise in an unmaintained version of a dependency. | ||||||||||
|
There was a problem hiding this comment. ...do we actually want to box ourselves in to this, or should we drop when upstream drops? There was a problem hiding this comment. I'd me more than happy to drop this, it seems a bit pointless. |
||||||||||
|
|
||||||||||
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. Do we not want to comment on the policy for any other dependencies? There was a problem hiding this comment. Do we have other deps we care about in this regard? There was a problem hiding this comment. Probably not, but it may be nice to explicitly say that we don't. There was a problem hiding this comment. 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 deprecation policies so that they can effectively | ||||||||||
erikjohnston marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
| 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. | ||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
this is item 4... :/
I'm hesitant to put this upfront in the installation instructions: there's a lot for new users to understand here, and I'm not entirely sure it belongs here
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 link it from the README instead?
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.
Fair, its a bit of a tricky balance. Maybe we should point to the doc whenever we mention min requirements?