From f2c757c362171cb266b79faf61b04b4271998129 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 9 Feb 2022 15:22:23 -0500 Subject: [PATCH 1/5] Add basic notes on the release cycle. --- docs/SUMMARY.md | 1 + docs/development/releases.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 docs/development/releases.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 3eeb1a2799d3..ef9cabf55524 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -79,6 +79,7 @@ # Development - [Contributing Guide](development/contributing_guide.md) - [Code Style](code_style.md) + - [Release Cycle](development/releases.md) - [Git Usage](development/git.md) - [Testing]() - [OpenTracing](opentracing.md) diff --git a/docs/development/releases.md b/docs/development/releases.md new file mode 100644 index 000000000000..900c361dee7e --- /dev/null +++ b/docs/development/releases.md @@ -0,0 +1,33 @@ +# Synapse Release Cycle + +New releases of Synapse nominally follow a two week release cycle: + +* Day 0: Synapse N - 1 is released. +* Day 7: Synapse N release candidate 1 is released. +* Days 7 - 13: Synapse N release candidates 2+ are released, if bugs are found. +* Day 14: Synapse N is released. + +Note that this schedule might be modified depending on the availability of the +Synapse team, e.g. releases may be skipped to avoid holidays. + +## Bugfix releases + +If a bug is found after release that is deemed to severe enough (by a combination +of the impacted users and the impact on those users) then a bugfix release may +be issued. This may be at any point in the release cycle. + +## Security releases + +Security will sometimes be backported to the previous version and released +immediately before the next release candidate. An example of this might be: + +* Day 0: Synapse N - 1 is released. +* Day 7: Synapse (N - 1).1 is released as Synapse N - 1 + the security fix. +* Day 7: Synapse N release candidate 1 is released (including the security fix). + +Depending on the impact and complexity of security fixes, multiple fixes might +be held to be released together. + +In some cases, a pre-disclosure of a security release will be issued as a notice +to Synapse operators that there is an upcoming security release. These can be +found on the [security category of the Matrix blog](https://matrix.org/blog/category/security). From c9ac3db397df01d8628b4fd32a263a13672a9307 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 9 Feb 2022 15:24:00 -0500 Subject: [PATCH 2/5] Newsfragment --- changelog.d/11954.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/11954.doc diff --git a/changelog.d/11954.doc b/changelog.d/11954.doc new file mode 100644 index 000000000000..6e7b3908909f --- /dev/null +++ b/changelog.d/11954.doc @@ -0,0 +1 @@ +Add information on the Synapse release cycle. From 0d8b6c8bf81b8f7abd4fb0c06ff5db42eaed0ab2 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Thu, 10 Feb 2022 07:41:18 -0500 Subject: [PATCH 3/5] Fix typo. Co-authored-by: reivilibre --- docs/development/releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/releases.md b/docs/development/releases.md index 900c361dee7e..f1786876e106 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -12,7 +12,7 @@ Synapse team, e.g. releases may be skipped to avoid holidays. ## Bugfix releases -If a bug is found after release that is deemed to severe enough (by a combination +If a bug is found after release that is deemed severe enough (by a combination of the impacted users and the impact on those users) then a bugfix release may be issued. This may be at any point in the release cycle. From c49dc2a84be29204cc7ff5e44f4228913d3add20 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Thu, 10 Feb 2022 07:41:29 -0500 Subject: [PATCH 4/5] Formatting. Co-authored-by: reivilibre --- docs/development/releases.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/development/releases.md b/docs/development/releases.md index f1786876e106..be2a8ae4c6f0 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -2,10 +2,10 @@ New releases of Synapse nominally follow a two week release cycle: -* Day 0: Synapse N - 1 is released. -* Day 7: Synapse N release candidate 1 is released. -* Days 7 - 13: Synapse N release candidates 2+ are released, if bugs are found. -* Day 14: Synapse N is released. +* Day 0: Synapse `N - 1` is released. +* Day 7: Synapse `N` release candidate 1 is released. +* Days 7 - 13: Synapse `N` release candidates 2+ are released, if bugs are found. +* Day 14: Synapse `N` is released. Note that this schedule might be modified depending on the availability of the Synapse team, e.g. releases may be skipped to avoid holidays. From d49a506a29209ac0d7ef903645c4b34c98bb5ef7 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Thu, 10 Feb 2022 07:44:54 -0500 Subject: [PATCH 5/5] Mention Tuesdays and include a link to the blog. --- docs/development/releases.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/development/releases.md b/docs/development/releases.md index be2a8ae4c6f0..c9a8c6994597 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -1,6 +1,7 @@ # Synapse Release Cycle -New releases of Synapse nominally follow a two week release cycle: +Releases of Synapse follow a two week release cycle with new releases usually +occurring on Tuesdays: * Day 0: Synapse `N - 1` is released. * Day 7: Synapse `N` release candidate 1 is released. @@ -10,6 +11,9 @@ New releases of Synapse nominally follow a two week release cycle: Note that this schedule might be modified depending on the availability of the Synapse team, e.g. releases may be skipped to avoid holidays. +Release announcements can be found in the +[release category of the Matrix blog](https://matrix.org/blog/category/releases). + ## Bugfix releases If a bug is found after release that is deemed severe enough (by a combination @@ -30,4 +34,4 @@ be held to be released together. In some cases, a pre-disclosure of a security release will be issued as a notice to Synapse operators that there is an upcoming security release. These can be -found on the [security category of the Matrix blog](https://matrix.org/blog/category/security). +found in the [security category of the Matrix blog](https://matrix.org/blog/category/security).