#######################
Open edX Nutmeg Release
#######################

.. tags:: site operator

.. warning::

    This release is unsupported.

    The :ref:`Open edX Release Notes` and the :ref:`Open edX Release Notes` are the
    authoratative sources of information on all Open edX releases. It is *strongly*
    recommended to operate off the latest Open edX release at all points in time, as
    only the most recent release is community-supported.

    See the `Open edX Release Schedule`_ for information on release dates and end-of-life
    support.

This section describes how to install the Open edX Nutmeg release.

.. contents::
 :local:
 :depth: 1

*************************
What's Included in Nutmeg
*************************

The Open edX Nutmeg release contains several new features for learners,
course teams, and developers. For more information, see the
`Open edX Platform Release Notes`__.

__ https://docs.openedx.org/en/latest/community/release_notes/nutmeg.html


***************************
What Is the Nutmeg Git Tag?
***************************

A git tag identifies the version of Open edX code that is the Nutmeg release.
About three dozen repositories are tagged as part of an Open edX release. Many
other repositories are installed as dependencies of those repositories. You can
find the most up-to-date git tag for Nutmeg on the
:ref:`Open edX Release Notes`.

*****************************
Installing the Nutmeg Release
*****************************

.. warning::

    This release is unsupported.

See `Tutor installation instructions <https://docs.tutor.edly.io/gettingstarted.html>`_.

Nutmeg releases have git tag names like ``open-release/nutmeg.1``.
The available names are detailed on the :ref:`Open edX Release Notes`.

********************************
Upgrading from the Maple Release
********************************

See `Tutor upgrade instructions <https://docs.tutor.edly.io/tutorials/oldreleases.html>`_.

****************************************
Upgrading to a Subsequent Nutmeg Release
****************************************

Occasionally, we release updates to Nutmeg.  For example, the second
release of Nutmeg will be ``open-release/nutmeg.2``.
The steps to upgrade differ based on your original installation method.

===============================
Upgrading a Docker Installation
===============================

The `devstack`_ installation method is deprecated. It is recommended
to migrate to Tutor. See `Tutor installation instructions <https://docs.tutor.edly.io/gettingstarted.html>`_.

===============================
Upgrading a Native Installation
===============================

If you installed Open edX using the Open edX Native Installation, please
migrate to Tutor. This `Native Installation to Tutor forum post`_ may be helpful,
as may be `this second Native to Tutor post`_. If not, post on the `Open edX Forums`_.


.. include:: /links.txt


**Maintenance chart**

+--------------+-------------------------------+----------------+------------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                      |
+--------------+-------------------------------+----------------+------------------------------------+
| 2025-03-09   | Sarina Canelake               | Sumac          |  Deprecated                        |
+--------------+-------------------------------+----------------+------------------------------------+