Skip to content

Commit e7da0a3

Browse files
committed
add breaking changes message to CHANGELOG.md
1 parent 150f6ed commit e7da0a3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## 2.0.0 (2022-09-xx)
4+
5+
### WARNING
6+
7+
**Breaking change:** Starting with version the 2.0.0 the category slugs are unique.
8+
While this brings big advantage for simplified category addressing, it can break projects that are containing categories with duplicated slugs.
9+
If your database contains colliding slugs, they will be automatically renamed by the migration.
10+
Three categories with slugs ``foo`` will be renamed to ``foo``, ``foo-1``, ``foo-2``.
11+
If this causes problems in your project, you can rename the categories yourself before running the migration.
12+
13+
314
## 1.9.2 (2022-09-22)
415
[Compare the full difference.](https://github.com/jazzband/django-categories/compare/1.9.1...1.9.2)
516

0 commit comments

Comments
 (0)