This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add deprecation policy doc #9723
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5853864
Add deprecation policy doc
erikjohnston 058f20c
Newsfile
erikjohnston fc0519f
Move to README
erikjohnston b35de3f
Apply suggestions from code review
erikjohnston acb7a7b
Strip out one month compatibility guarentee
erikjohnston 37a92e4
Apply suggestions from code review
erikjohnston 853054d
Merge branch 'release-v1.31.0' into erikj/deprecation_policy
erikjohnston File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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. | ||
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,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. | ||
|
||
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. |
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.
Maybe just: