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

Reduced ESR maintenance overhead with file includes #7721

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
1 change: 1 addition & 0 deletions source/about/common-esr-support-rst.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Support for Mattermost Server v9.5 :ref:`Extended Support Release <about/release-policy:extended support releases>` has come to the end of its life cycle on November 15, 2024. Upgrading to :doc:`Mattermost Server v9.11 or later </about/mattermost-server-releases>` is required.
cwarnermm marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions source/about/common-esr-support-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
cwarnermm marked this conversation as resolved.
Show resolved Hide resolved
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the [v9.11 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-11-extended-support-release).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amyblais - Does the example here make sense? Or should it get bumped to v10.5 as well?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the example makes sense.

- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
1 change: 1 addition & 0 deletions source/about/common-esr-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Support for Mattermost Server v9.5 :ref:`Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to [Mattermost Server v9.11](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-11-extended-support-release) or later is required.
cwarnermm marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions source/about/desktop-app-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

This changelog summarizes updates to Mattermost desktop app releases for [Mattermost](https://mattermost.com).

```{Important}
```{include} common-esr-support.md
```

(release-v5-10)=
## Release v5.10

Expand Down
2 changes: 1 addition & 1 deletion source/about/mattermost-desktop-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
```

```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
```{include} common-esr-support.md
```

## Frequency
Expand Down
7 changes: 5 additions & 2 deletions source/about/mattermost-mobile-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
```

```{Important}
- Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- We strongly recommend using the latest mobile app release available that contains the latest security fixes and user experience enhancements. Mobile app releases are tested against all generally available Mattermost server and extended support releases.
```{include} common-esr-support.md
```

## Frequency
Expand All @@ -14,6 +13,10 @@ Mattermost releases a new mobile app version every month. Mattermost tests the l

See the [Mobile app changelog](/about/mobile-app-changelog) for release details, and see the [iOS mobile app](/collaborate/install-ios-app) and the [Android mobile app](/collaborate/install-android-app) documentation for installation details.

```{Important}
We strongly recommend using the latest mobile app release available that contains the latest security fixes and user experience enhancements. Mobile app releases are tested against all generally available Mattermost server and extended support releases.
```

## Latest releases

| **Release** | **Released on** | **Support ends** | **Compatible with** |
Expand Down
3 changes: 1 addition & 2 deletions source/about/mattermost-server-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
```

```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
```{include} common-esr-support-upgrade.md
```

## Frequency
Expand Down
5 changes: 1 addition & 4 deletions source/about/mattermost-v10-changelog.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# v10 changelog

```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
```{include} common-esr-support-upgrade.md
```

(release-v10.4-feature-release)=
Expand Down
7 changes: 3 additions & 4 deletions source/about/mattermost-v9-changelog.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# v9 changelog


```{Important}
Support for Mattermost Server v9.5 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
```{include} common-esr-support-upgrade.md
```


(release-v9-11-extended-support-release)=
## Release v9.11 - [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#release-types)

Expand Down
4 changes: 4 additions & 0 deletions source/about/mobile-app-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

This changelog summarizes updates to Mattermost mobile apps releases for [Mattermost](https://mattermost.com).

```{Important}
```{include} common-esr-support.md
```

(release-v2-24-1)=
## 2.24.1 Release
- Release Date: January 17, 2025
Expand Down
3 changes: 2 additions & 1 deletion source/about/releases-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Releases and life cycle

.. important::

Support for Mattermost Server v8.1 :ref:`Extended Support Release <about/release-policy:extended support releases>` has come to the end of its life cycle in May 15, 2024. Upgrading to Mattermost Server v9.5 or later is required.

.. include:: ../about/common-esr-support-rst.rst

.. toctree::
:maxdepth: 1
Expand Down
3 changes: 1 addition & 2 deletions source/about/unsupported-legacy-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
## Release v8.1 - [Extended Support Release](https://docs.mattermost.com/upgrade/release-definitions.html#extended-support-release-esr)

```{Important}
- Support for Mattermost Server v8.1 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on May 15, 2024. [Upgrading Mattermost Server](https://docs.mattermost.com/about/mattermost-server-releases.html#latest-releases) is required.
- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
```{include} common-esr-support-upgrade.md
```

- **8.1.13, released 2024-04-25**
Expand Down
13 changes: 10 additions & 3 deletions source/about/version-archive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ Version archive
:start-after: :nosearch:

.. important::
- Support for Mattermost Server v9.5 :ref:`Extended Support Release <about/release-policy:extended support releases>` has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- Note that our package signing key has been moved away from Keybase. If you still reference Keybase in your deployment steps for retrieving the key, update them to the new key location: https://deb.packages.mattermost.com/pubkey.gpg.
- If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-256 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored at the following URL: https://deb.packages.mattermost.com/pubkey.gpg.


.. include:: ../about/common-esr-support-rst.rst


If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-256 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored at the following URL: https://deb.packages.mattermost.com/pubkey.gpg.

.. note::

Our package signing key has been moved away from Keybase. If you still reference Keybase in your deployment steps for retrieving the key, update them to the new key location: https://deb.packages.mattermost.com/pubkey.gpg.

.. tab:: Mattermost Enterprise

Expand Down
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3778,7 +3778,7 @@ def setup(_: Sphinx):

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["archive/*", "process/*"]
exclude_patterns = ["archive/*", "process/*", "/about/common-esr-support.md", "/about/common-esr-support-upgrade.md"]

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down
3 changes: 2 additions & 1 deletion source/install/prepare-mattermost-mysql-database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Prepare your Mattermost MySQL database

.. important::

PostgreSQL is our preferred database of choice. See the :ref:`database software <install/software-hardware-requirements:database software>` documentation for details on database version support, and see the :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` documentation for details on migrating from MySQL to PostgreSQL.
- PostgreSQL is our preferred database of choice. See the :ref:`database software <install/software-hardware-requirements:database software>` documentation for details on database version support, and see the :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` documentation for details on migrating from MySQL to PostgreSQL.
- MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.

Set up the Mattermost MySQL database
------------------------------------
Expand Down
4 changes: 4 additions & 0 deletions source/install/software-hardware-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ Search limitations on MySQL:
MySQL 8 Support
::::::::::::::::

.. important::

MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.

In MySQL 8.0.4, the default authentication plugin was changed from ``mysql_native_password`` to ``caching_sha2_password``. Therefore, you will need to enable ``mysql_native_password`` by adding the following entry in your MySQL configuration file:

.. code-block:: text
Expand Down
14 changes: 6 additions & 8 deletions source/upgrade/important-upgrade-notes.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
Important Upgrade Notes
=======================

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

.. important::
- Support for Mattermost Server v9.5 :ref:`Extended Support Release <about/release-policy:extended support releases>` has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 or later is required.
- MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.
- Upgrading the Microsoft Teams Calling plugin to v2.0.0 requires users to reconnect their accounts.
- When upgrading to 7.x from a 5.x release please make sure to upgrade to 5.37.10 first for the upgrade to complete successfully.
- Mattermost plugins built with Go versions 1.22.0 and 1.22.1 do not work. Plugin developers should use go 1.22.2 or newer instead.


.. include:: ../about/common-esr-support-rst.rst

- Upgrading the Microsoft Teams Calling plugin to v2.0.0 requires users to reconnect their accounts.
- Mattermost plugins built with Go versions 1.22.0 and 1.22.1 do not work. Plugin developers should use Go 1.22.2 or newer instead.
- Keybase has stopped serving our Ubuntu repository signing key. If you were using it, update your installation scripts to retrieve the key as mentioned in our docs: https://docs.mattermost.com/install/install-ubuntu.html.

+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down
4 changes: 0 additions & 4 deletions source/upgrade/prepare-to-upgrade-mattermost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@ We strongly recommend that you:
- Keep a backup of your database to ensure you can load a previous database snapshot if necessary.
- Upgrade your instance of Mattermost to the latest :doc:`Extended Support Release (ESR) </about/mattermost-server-releases>` first before attempting to run the Mattermost v6.0 upgrade.

.. important::

Support for Mattermost Server v9.5 :doc:`Extended Support Release </about/mattermost-server-releases>` has come to the end of its life cycle on November 15, 2024. Upgrading to Mattermost Server v9.11 Extended Support Release or later is required. Upgrading from a previous Extended Support Release to the latest Extended Support Release is supported. Upgrading from v5.31 to v5.37 should take roughly the same amount of time as upgrading from v5.31 to v5.35, then upgrading v5.35 to 5.37. However, an upgrade directly from v5.31 to v5.37 could potentially take hours due to the database schema migrations required for v5.35. Review the :doc:`important-upgrade-notes` for all intermediate versions in between to ensure you’re aware of the possible migrations that could affect your upgrade.

v6.0 database schema migrations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down