===============================
Mayan EDMS v3.1.8 release notes
===============================

Released: October XX, 2018

Changes
~~~~~~~


Removals
--------

* None

Upgrading from a previous version
---------------------------------


If installed via Python's PIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Remove deprecated requirements::

    $ curl https://gitlab.com/mayan-edms/mayan-edms/raw/master/removals.txt | pip uninstall -r /dev/stdin

Type in the console::

    $ pip install mayan-edms==3.1.8

the requirements will also be updated automatically.


Using Git
~~~~~~~~~

If you installed Mayan EDMS by cloning the Git repository issue the commands::

    $ git reset --hard HEAD
    $ git pull

otherwise download the compressed archived and uncompress it overriding the
existing installation.

Remove deprecated requirements::

    $ pip uninstall -y -r removals.txt

Next upgrade/add the new requirements::

    $ pip install --upgrade -r requirements.txt


Common steps
~~~~~~~~~~~~
Perform these steps after updating the code from either step above.

Migrate existing database schema with::

    $ mayan-edms.py performupgrade

Add new static media::

    $ mayan-edms.py collectstatic --noinput

The upgrade procedure is now complete.


Backward incompatible changes
-----------------------------

* None

Bugs fixed or issues closed
===========================

* `GitLab issue #529 <https://gitlab.com/mayan-edms/mayan-edms/issues/529>`_ Submitting a metadata value with the `&` character truncates string
* `GitLab issue #530 <https://gitlab.com/mayan-edms/mayan-edms/issues/530>`_ Email Link form does not accept commas or semicolons to separate multiple addresses

.. _PyPI: https://pypi.python.org/pypi/mayan-edms/
