diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 6e2562aa..34e842b3 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,19 @@ Changelog for the **SODAR Core** Django app package. Loosely follows the `Keep a Changelog `_ guidelines. +Unreleased +========== + +Changed +------- + +- **General** + - Upgrade minimum Django version to v4.2.9 (#880) + - Upgrade minimum PostgreSQL version to v12 (#1074) + - Upgrade to PostgreSQL v16 in CI (#1074) + - Add Python v3.11 support (#1157) + + v0.13.4 (2024-02-16) ==================== diff --git a/docs/source/conf.py b/docs/source/conf.py index c0712f2d..83c27486 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,9 +27,9 @@ author = 'BIH Core Unit Bioinformatics' # The short X.Y version -version = '0.13' +version = '1.0' # The full version, including alpha/beta/rc tags -release = '0.13.4' +release = '1.0-WIP' # -- General configuration --------------------------------------------------- diff --git a/docs/source/major_changes.rst b/docs/source/major_changes.rst index 32e52cca..7a349914 100644 --- a/docs/source/major_changes.rst +++ b/docs/source/major_changes.rst @@ -10,6 +10,52 @@ older SODAR Core version. For a complete list of changes in current and previous releases, see the :ref:`full changelog`. +v1.0.0 (WIP) +************ + +Release Highlights +================== + +- Upgrade to Django v4.2 and Postgres v16 +- Add Python 3.11 support + +Breaking Changes +================ + +Django v4.2 Upgrade +------------------- + +This release updates SODAR Core from Django v3.2 to v4.2. This is a breaking +change which causes many updates and also potentially requires updating several +dependencies. + +To upgrade, please update the Django requirement along with your site's other +Python requirements to match ones in ``requirements/*.txt``. See +`Django deprecation documentation `_ +for details about what has been deprecated in Django and which changes are +mandatory. + +Common known issues: + +- Minimum version of PostgreSQL has been bumped to v12. +- Replace ``django.utils.translation.ugettext_lazy`` imports with + ``gettext_lazy``. +- Replace ``django.conf.urls.url`` imports with ``django.urls.re_path``. +- Calls for ``related_managers`` for unsaved objects raises ``ValueError``. This + can be handled by e.g. calling ``model.save(commit=False)`` before trying to + access foreign key relations. + +System Prerequisites +-------------------- + +The minimum required PostgreSQL version has been bumped to v12. In CI we +currently use PostgreSQL v16, but anything from v12 to above should work with +this SODAR Core release. + +Python v3.11 support has been officially added in this version. Also, 3.11 is +now the recommended Python version to be used. + + v0.13.4 (2024-02-16) ********************