Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release lifecycle docs overhaul & simplification #7110

Merged
merged 64 commits into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
fc02104
Started framework for new release lifecycle docs/guidance
cwarnermm May 6, 2024
44014c1
Interim commit of markdown-formatted rel mgmt pages
cwarnermm May 16, 2024
2702bb1
Merge branch 'master' into release-lifecycle-updates
cwarnermm May 16, 2024
244a21e
Added navigation & desktp/mobile app framework
cwarnermm May 16, 2024
a63f573
Converted desktop changelog to MD; added new release pages
cwarnermm Jun 6, 2024
8ed5c30
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 7, 2024
6582cbe
Populated outstanding release life cycle sections & fixed links
cwarnermm Jun 7, 2024
ace77f5
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 7, 2024
1a01a11
Incorporated ESR restore & legacy details
cwarnermm Jun 7, 2024
828d72e
Merge branch 'release-lifecycle-updates' of https://github.com/matter…
cwarnermm Jun 7, 2024
40c0fdd
Update mattermost-v9-changelog.md
amyblais Jun 7, 2024
34682fe
Update mattermost-server-releases.md
amyblais Jun 7, 2024
da5c8f1
Update mattermost-v10-changelog.md
amyblais Jun 7, 2024
5a28c98
Update mattermost-mobile-releases.md
amyblais Jun 7, 2024
9a3e4ab
Update mattermost-mobile-releases.md
amyblais Jun 7, 2024
c7a1666
Update mattermost-desktop-releases.md
amyblais Jun 7, 2024
a85866f
Update mattermost-desktop-releases.md
amyblais Jun 7, 2024
263c6d6
Update mattermost-mobile-releases.md
amyblais Jun 7, 2024
c1c9590
Update mattermost-mobile-releases.md
amyblais Jun 7, 2024
1671e57
Update mattermost-desktop-releases.md
amyblais Jun 7, 2024
ed281d4
Update release-lifecycle.rst
amyblais Jun 10, 2024
acca9de
Update client-compatibility.md
amyblais Jun 10, 2024
3091992
Update client-compatibility.md
amyblais Jun 10, 2024
433360f
Update mattermost-desktop-releases.md
amyblais Jun 10, 2024
f4a6516
Update mattermost-mobile-releases.md
amyblais Jun 10, 2024
4fcf1df
Update mattermost-server-releases.md
amyblais Jun 10, 2024
a6718ec
Update mattermost-v10-changelog.md
amyblais Jun 10, 2024
2b39bc3
Update mattermost-v9-changelog.md
amyblais Jun 10, 2024
70c86b0
Update mattermost-desktop-releases.md
amyblais Jun 10, 2024
64deda2
Update important-upgrade-notes.rst
amyblais Jun 10, 2024
f6b10ca
Update version-archive.rst
amyblais Jun 10, 2024
eb33b51
Update release-lifecycle.rst
amyblais Jun 10, 2024
91333e3
Update mattermost-server-releases.md
amyblais Jun 10, 2024
b981d75
Update mattermost-v10-changelog.md
amyblais Jun 10, 2024
7d81af8
Update mattermost-v9-changelog.md
amyblais Jun 10, 2024
52210c3
Update mattermost-mobile-releases.md
amyblais Jun 10, 2024
3ea2500
Update mattermost-desktop-releases.md
amyblais Jun 10, 2024
923d6de
Update mattermost-desktop-releases.md
amyblais Jun 10, 2024
b5ba561
Update mattermost-mobile-releases.md
amyblais Jun 10, 2024
663404e
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 13, 2024
baf965f
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 14, 2024
295b12a
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 14, 2024
390f1df
Link syntax fixes
cwarnermm Jun 14, 2024
b90327c
Merge branch 'master' into release-lifecycle-updates
mattermost-build Jun 14, 2024
8daeea1
Link syntax fixes
cwarnermm Jun 14, 2024
2b67de1
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 18, 2024
6b98b65
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 20, 2024
51ff61d
Update mattermost-v10-changelog.md
amyblais Jun 26, 2024
3f98193
Update mattermost-v9-changelog.md
amyblais Jun 26, 2024
7d017d3
Update version-archive.rst
amyblais Jun 26, 2024
5e1f478
Update mattermost-desktop-releases.md
amyblais Jun 26, 2024
47332ac
Update mattermost-mobile-releases.md
amyblais Jun 26, 2024
5a79827
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 26, 2024
2dbdef4
Incorporated reviewer feedback
cwarnermm Jun 26, 2024
4722a8a
Terminology/label update
cwarnermm Jun 26, 2024
16d1d9b
Broken link fix
cwarnermm Jun 26, 2024
37f2447
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 27, 2024
e610d4a
Incorporated reviewer feedback
cwarnermm Jun 27, 2024
1bf04bb
Update mattermost-v9-changelog.md
amyblais Jun 27, 2024
7b0cbda
Update version-archive.rst
amyblais Jun 27, 2024
f3a61da
Update version-archive.rst
amyblais Jun 27, 2024
b6e3a0e
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 28, 2024
71022fd
Incorporated reviewer feedback & updated page redirects
cwarnermm Jun 28, 2024
777a023
Merge branch 'master' into release-lifecycle-updates
cwarnermm Jun 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions source/_static/badges/allplans-cloud-selfhosted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```{raw} html
<div class="mm-plans-badge">
```

![plans-img](../_static/images/badges/flag_icon.svg) Available on [all plans](https://mattermost.com/pricing/)

!|deployment-img| [Cloud](https://mattermost.com/sign-up/) and [self-hosted](https://mattermost.com/deploy/) deployments

```{raw} html
</div>
```
11 changes: 11 additions & 0 deletions source/_static/badges/allplans-selfhosted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
```{raw} html
<div class="mm-plans-badge">
```

![plans-img](../_static/images/badges/flag_icon.svg) Available on [all plans](https://mattermost.com/pricing/)

![deployment-img](../_static/images/badges/deployment_icon.svg) [self-hosted](https://mattermost.com/deploy/) deployments

```{raw} html
</div>
```
12 changes: 12 additions & 0 deletions source/_static/badges/ent-only.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
```{raw} html
<div class="mm-plans-badge">
```

![plans-img](../_static/images/badges/flag_icon.svg) Available only on [Enterprise](https://mattermost.com/pricing/) plans

```{raw} html
</div>
```



4 changes: 2 additions & 2 deletions source/deploy/desktop-app-changelog.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Desktop application changelog
==============================
Desktop app changelog
=====================

This changelog summarizes updates to Mattermost desktop app releases for `Mattermost <https://mattermost.com>`__.

Expand Down
991 changes: 991 additions & 0 deletions source/deploy/mattermost-v9-changelog.md

Large diffs are not rendered by default.

14,011 changes: 14,011 additions & 0 deletions source/deploy/unsupported-legacy-releases.md

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions source/guides/client-compatibility.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Client compatibility
=====================

all plans; cloud & self-hosted

what this section is about and who it's for

see also: release lifecycle

.. toctree::
:maxdepth: 1
:hidden:
:titlesonly:

Desktop app </collaborate/access-your-workspace>
Mobile app

* :doc:`Access your Mattermost workspace </collaborate/access-your-workspace>` - Log in to a Mattermost workspace to connect with your teammates.
2 changes: 2 additions & 0 deletions source/guides/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o
:hidden:
:titlesonly:

Release life cycle </guides/release-lifecycle>
Prepare your Mattermost database </install/prepare-mattermost-database>
Deploy on Ubuntu </install/install-ubuntu>
Deploy using Docker </install/install-docker>
Expand All @@ -35,6 +36,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o

* Encountering issues with your deployment? See the :ref:`Deployment Troubleshooting <install/troubleshooting:deployment troubleshooting>` or :doc:`high scale troubleshooting </deploy/high-scale-troubleshoot>` documentation for details.

* :doc:`Matermost release lifecycle </guides/release-lifecycle>` - Learn about Mattermost releases, and our recommended practices around deployment updates and ESRs.
* :doc:`Prepare your Mattermost database </install/prepare-mattermost-database>` - Learn how to prepare and configure a database for Mattermost.
* :doc:`Deploy on Ubuntu </install/install-ubuntu>` - Signed packages direct from Mattermost featuring a single command for install and upgrades.
* :ref:`Deploy using Docker <install/install-docker:deploy mattermost on docker for production use>` - The fastest way to try Mattermost and a great single server installation option.
Expand Down
36 changes: 36 additions & 0 deletions source/guides/release-lifecycle.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Release lifecycle
=================

.. include:: ../_static/badges/allplans-selfhosted.rst
:start-after: :nosearch:

.. important::

**Support for Mattermost Server v8.1 Extended Support Release has come to the end of its life cycle on May 15, 2024. Upgrading to Mattermost Server v9.5 Extended Support Release or later is required.**

.. toctree::
:maxdepth: 1
:hidden:
:titlesonly:

Mattermost release policy </lifecycle/release-policy>
Mattermost Server releases </lifecycle/mattermost-server-releases>
Mattermost v9 changelog </deploy/mattermost-v9-changelog>
Unsupported legacy releases </deploy/unsupported-legacy-releases>
Server version archive </lifecycle/version-archive>
Desktop app releases <need path>
Desktop app changelog </deploy/desktop-app-changelog>
Mobile apps release <need path>
Mobile apps changelog </deploy/mobile-app-changelog>

* :doc:`Mattermost release policy </lifecycle/release-policy>` - Learn about Mattermost’s release policy, and our recommended practices around deployment updates and ESRs.
* :doc:`Mattermost server releases </lifecycle/mattermost-server-releases>` - Learn more about supported Mattermost server releases.
* :doc:`Mattermost v9 changelog </deploy/mattermost-v9-changelog>` - Learn more about what's new and changed in Mattermost v9 releases.
* :doc:`Unsupported legacy releases </deploy/unsupported-legacy-releases>` - Learn what changed in legacy Mattermost releases that are no longer supported.
* :doc:`Version archive </lifecycle/version-archive>` - Confirm the version of Mattermost Server you're using is official by its signature.
* :doc:`Desktop app releases <need path>` - Learn more about supported Mattermost desktop app releases.
* :doc:`Desktop app changelog </deploy/desktop-app-changelog>` - Learn more about what's new and changed in Mattermost desktop app releases.
* :doc:`Mobile apps <need path>` - Learn more about supported Mattermost mobile app releases.
* :doc:`Mobile apps changelog </deploy/mobile-app-changelog>` - Learn more about what's new and changed in Mattermost mobile app releases.


26 changes: 26 additions & 0 deletions source/lifecycle/mattermost-server-releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Mattermost Server releases

```{include} ../_static/badges/allplans-selfhosted.md
```

```{Important}
**Support for Mattermost Server v8.1 Extended Support Release has come to the end of its life cycle on May 15, 2024. Upgrading to Mattermost Server v9.5 Extended Support Release or later is required.**
```

## Frequency
Mattermost releases a new server version on the 16th of each month in [binary form](/upgrade/upgrading-mattermost-server). See the [Mattermost v9 changelog](/deploy/mattermost-v9-changelog) for details on v9.x server releases, and [unsupported Mattermost legacy releases](/deploy/unsupported-legacy-releases) for older Mattermost releases.

## Latest releases

| **Release** | **Life cycle start** | **Life cycle end** |
amyblais marked this conversation as resolved.
Show resolved Hide resolved
|:---|:---|:---|
| v9.8 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.8.0/mattermost-9.8.0-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-8-feature-release>` | 2024-05-16 | 2024-08-15 |
| v9.7 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.7.3/mattermost-9.7.3-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-7-feature-release>` | 2024-04-16 | 2024-07-15 |
| v9.6 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.6.2/mattermost-9.6.2-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-6-feature-release>` | 2024-03-16 | 2024-06-15 |
| v9.5 {ref}`EXTENDED <release-types>` \| [Download](https://releases.mattermost.com/9.5.4/mattermost-9.5.4-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-5-extended-support-release>` | 2024-02-16 | 2024-11-15 |
| v9.4 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.4.5/mattermost-9.4.5-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-4-feature-release>` | 2024-01-16 | 2024-04-15 |
| v9.3 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.3.3/mattermost-9.3.3-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-3-feature-release>` | 2023-12-16 | 2024-03-15 |
| v9.2 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.2.6/mattermost-9.2.6-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-2-feature-release>` | 2023-11-16 | 2024-02-15 |
| v9.1 {ref}`FEATURE <release-types>` \| [Download](https://releases.mattermost.com/9.1.5/mattermost-9.1.5-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-1-feature-release>` | 2023-10-16 | 2024-01-15 |
| v9.0 {ref}`MAJOR <release-types>` \| [Download](https://releases.mattermost.com/9.0.5/mattermost-9.0.5-linux-amd64.tar.gz) \| {ref}`Changelog <release-v9-0-major-release>` | 2023-09-16 | 2023-12-15 |
| | | |
58 changes: 58 additions & 0 deletions source/lifecycle/release-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Release policy

```{include} ../_static/badges/allplans-selfhosted.md
```

This page describes Mattermost’s release policy, and our recommended practices around releases, including extended support releases, so that you can allocate your IT resources effectively.

To ensure a secure, functional, performant, and efficient Mattermost deployment, system admins managing a self-hosted deployment need to be proactive in:
- monitoring Mattermost release cycles and planning upgrades before life cycles end,
- considering the use of [extended support releases](#extended-support-releases) for longer-term stability, and
- keeping both server and client applications updated.

(release-types)=
## Release types

Mattermost releases include feature, extended support, and major releases. Each release has a specified life cycle start and end date, and life cycles depend on the release type.

- **Feature**: Feature releases contain new features and include high severity and high impact security backported to the previous 3 monthly releases. This is to ensure your organization's Mattermost deployment remains secure and stable. It's crucial to apply feature updates to maintain the security of your Mattermost deployment.
- **Extended**: Releases maintained for a longer period of time that receive backports for security fixes and major bug fixes for the length of their life cycle. Learn more about [Mattermost extended support releases](#extended-support-releases) below.
- **Major**: Annual mid-year releases that follow a release theme, and include multiple new features.

With multiple release types, you can plan the upgrade path that best suits your organization's needs and compliance requirements. Align your plan with your organization's IT strategy and risk management policies to ensure continuous operation without exposure to security vulnerabilities.

See the full list of all Mattermost Server and desktop app releases and life cycles.

(extended-support-releases)=
## Extended support releases

```{include} ../_static/badges/ent-only.md
```

Mattermost Extended Support Releases (ESRs) are a strategic choice for organizations looking for stability and reduced frequency of updates. Using ESRs can minimize disruptions associated with frequent upgrades, making them an attractive option for environments where stability is paramount. New ESRs are released twice a year, every February and August release. An ESR is supported for nine months to provide customers with enough time to test and upgrade to the next ESR.

We strongly recommend planning ahead for upgrades before the end of an ESR's life cycle to ensure continuity in receiving security updates.

ESRs don’t include changes to product functionality or new features. ESRs are intended for organizations who value stability over having the newest features and improvements, or who have a long internal testing and certification process to undergo when upgrading. Consider using ESRs for more stable and long-term deployments, especially in environments where frequent updates are challenging. If your organization prefers to have the newest features and improvements, Extended Support Releases may not be the best fit for you.

See the full list of all Mattermost Server and desktop app releases and life cycles, including extended support releases. To install extended support releases, follow our [install](https://docs.mattermost.com/guides/deployment.html) or [upgrade](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) documentation.

```{Important}
We strongly recommend reviewing [upgrade best practices](https://docs.mattermost.com/upgrade/prepare-to-upgrade-mattermost.html#upgrade-best-practices) for upgrading, and [important upgrade notes](/upgrade/important-upgrade-notes) for all the versions beyond the current ESR version you have currently installed. See the [Mattermost v9 changelog](/deploy/mattermost-v9-changelog) for a list of database, API, and `config.json` updates for all v9.x releases.
```

![Timeline-based chart showing the lifecycle of Mattermost Extended Support Releases and feature releases from last year and this year.](../images/ESR_graphic2.png)

(esr-notifications)=
### ESR Notifications

```{include} ../_static/badges/ent-only.md
```

When an ESR is at the end of its life cycle, there will be announcements ahead of time to provide time for people to test, certify, and deploy a newer ESR version before support ends. After a release reaches its end-of-life, no further updates will be provided for that version.

To receive updates about Extended Support Releases, sign up for [our mailing list](https://eepurl.com/dCKn2P).

For a new upcoming ESR, an email is sent out 3 months before the end of support for an ESR version. This email includes a note about the new ESR that was just published. A second email is sent out during the month when an ESR version is reaching the end of support.

For deprecated ESRs, an email announcement is sent 3 months in advance. We also add reminders on our release announcements, changelogs, important upgrade notes, and the [Mattermost Discussion Forums](https://forum.mattermost.com/) site.
Loading
Loading