Bump version and update documentation

jrobichaud · Dec 13, 2023 · 4e857f8 · 4e857f8
1 parent e7cb635
commit 4e857f8
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -362,6 +362,17 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_7.0:
+
+Upgrading to 7.0+
+^^^^^^^^^^^^^^^^^
+
+The dependency `django-ipware <https://github.com/un33k/django-ipware>`_ was upgraded to version 6. This library is used to retrieve the request's ip address.
+
+Version 6 may have some `breaking changes <https://github.com/un33k/django-ipware/compare/v5.0.2...v6.0.2#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R97>`_ if you did customizations.
+
+It should not affect most of the users but if you did some customizations, you might need to update your configurations.
+
 .. _upgrade_6.0:
 
 Upgrading to 6.0+

diff --git a/django_structlog/__init__.py b/django_structlog/__init__.py
@@ -4,6 +4,6 @@
 
 name = "django_structlog"
 
-VERSION = (6, 1, 0, "dev2")
+VERSION = (7, 0, 0, "dev1")
 
 __version__ = ".".join(str(v) for v in VERSION)
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,15 +1,18 @@
 Change Log
 ==========
 
-6.1 (TBD)
+7.0.0
 ---------
 
+See: :ref:`upgrade_7.0`
+
 *New:*
     - (celery) add ``priority`` (if available) and ``routing_key`` to ``task_enqueued``. See `#345 <https://github.com/jrobichaud/django-structlog/pull/345>`_ and `#341 <https://github.com/jrobichaud/django-structlog/issues/341>`_. Special thanks to `badziyoussef <https://github.com/badziyoussef>`_.
-    - Django 5.0 support. See `#350 <https://github.com/jrobichaud/django-structlog/pull/350>`_. Take note async view cancellation does not work yet, see `#351 <https://github.com/jrobichaud/django-structlog/issues/351>`_.
+    - Django 5.0 support. See `#350 <https://github.com/jrobichaud/django-structlog/pull/350>`_. Take note async view cancellation when using ``asgi`` does not work yet, see `#351 <https://github.com/jrobichaud/django-structlog/issues/351>`_.
     - Add streaming response support (for both sync and async) and Django 5's async cancellation. See `#353 <https://github.com/jrobichaud/django-structlog/pull/353>`_ and :ref:`streaming_response_events`.
 
 *Changes:*
+    - Supports django-ipware 6+ only. See `#403 <https://github.com/jrobichaud/django-structlog/pull/403>`_. Special thanks to the maintainer `@un33k <https://github.com/un33k>`_.
     - Drop support of django 4.0. See `#338 <https://github.com/jrobichaud/django-structlog/pull/338>`_. Special thanks to `@jairhenrique <https://github.com/jairhenrique>`_.
 
 *Other:*