From 98de0bbd38aecae598762f5c8f29071c682e664d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20Dlouh=C3=BD?= Date: Mon, 26 Sep 2022 11:18:28 +0200 Subject: [PATCH] add breaking changes message to CHANGELOG.md --- CHANGELOG.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9983e079..36a7b681 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## 2.0.0 (2022-09-xx) + +### WARNING + +**Breaking change:** Starting with version the 2.0.0 the category slugs are unique. +While this brings big advantage for simplified category addressing, it can break projects that are containing categories with duplicated slugs. +If your database contains colliding slugs, they will be automatically renamed by the migration. +Three categories with slugs ``foo`` will be renamed to ``foo``, ``foo-1``, ``foo-2``. +If this causes problems in your project, you can rename the categories yourself before running the migration. + ## 1.9.1 (2022-09-21) [Compare the full difference.](https://github.com/jazzband/django-categories/compare/1.9.0...1.9.1)