v3.0.0

What's Changed

• update docs folder link by @Arhell in #465
• Fix LogEntry.changes_dict() to return {} when json.loads() returns None by @tykling in #472
• Complete translation with gettext_lazy by @ZahraEbrahimi01 in #474
• Using changes_dict in admin list by @rptmat57 in #479
• feat: Make timestamp in LogEntry overwritable by @aqeelat in #478
• Correlation ID - Part 1 by @aqeelat in #481
• Adding Custom Pre- and Post- Log Hooks by @aqeelat in #483
• Modify change field to be a json field. by @sum-rock in #407
• Change diff to evaluate PKs for FK relationships by @sum-rock in #420
• Convert AUDITLOG_EXCLUDE_TRACKING_MODELS to tuple before concatenate by @aivarsk in #488
• Fix repr of a json field in field changes by @CleitonDeLima in #489
• raise AuditLogRegistrationError on invalid app in settings by @tykling in #492
• Always call set_actor by @aqeelat in #484
• Run django main tests on Python >= 3.10 by @hramezani in #499
• Add ability to globally exclude fields by name on all models by @darkpixel in #498
• Add null=True to ci field by @hramezani in #506
• Add 2.2.2 changelog by @hramezani in #510
• Fix a bug in audit log admin page when USE_TZ=False by @hramezani in #511
• Make M2M changes comply with JSONField properly by @josefdlange in #514
• Fix GitHub actions deprecations by @aleh-rymasheuski in #520
• Audit changes to FK fields when saved using *_id naming. by @barqshasbite in #525
• fixed getting field's verbose_name by @AllYouZombies in #508
• Confirm Django 4.2 support by @hramezani in #529
• Fix unnecessary log when adding already existed m2m record by @firtk in #535
• Drop Django 4 support by @hramezani in #540
• Fix a bug in serialized_data with F expressions by @hramezani in #544
• Drop support for Python 3.7 by @hramezani in #546
• Improve auto model registration by @aqeelat in #550
• feat: give users the option to run the json migration asyncly by @aqeelat in #495
• chore: upgrade github action versions by @aqeelat in #553
• Set history delete_related to False by default by @aleh-rymasheuski in #557
• Allow cascade deletion of auditlog entries by @aleh-rymasheuski in #556
• Prepare for 3.0.0 release by @aqeelat in #555
• Pass instance_old to post_log.send by @ilius in #558
• fix: only fire the post_log signal when the log is created or when there is an error by @aqeelat in #561
• Stop deleting log entries in log_create by @aleh-rymasheuski in #559
• chore: add a check arg to the migration command by @aqeelat in #563
• fix: don't set the correlation_id if the AUDITLOG_CID_GETTER is None by @aqeelat in #565
• Update postgres to 13 by @hramezani in #568
• fix: change verbose_name in changes_text migration by @aqeelat in #571
• Fix Read The Docs build by @hugovk in #578
• Confirm Python 3.12 support by @jgillard in #572
• use contextvar instead of threadlocal by @hamedsh in #581
• Conditionally disable / enable logging by @errrken in #590
• Handle ObjectDoesNotExist in evaluation of object_repr by @aleh-rymasheuski in #592
• Confrim Django 5.0 and drop django 4.1 by @hramezani in #598
• Include LogEntry instance in post_log signal by @ppmathis in #605
• Avoid exception in changes_display_dict when model is missing by @ppmathis in #609
• Keep GitHub Actions up to date with GitHub's Dependabot by @cclauss in #618
• Bump the github-actions group with 4 updates by @dependabot in #619
• Correcting a typo in usage.rst by @plmrn in #615
• Disable logging remote IP address by @Nathan-Cohen in #620
• Add note about V3 to readme by @hramezani in #626
• Fix serialize proxy objects before logging by @Nathan-Cohen in #624
• Fixed manuall logging when model is not registered by @hramezani in #627
• Prepare release 3.0.0 by @hramezani in #629

New Contributors

• @tykling made their first contribution in #472
• @ZahraEbrahimi01 made their first contribution in #474
• @aivarsk made their first contribution in #488
• @CleitonDeLima made their first contribution in #489
• @darkpixel made their first contribution in #498
• @josefdlange made their first contribution in #514
• @barqshasbite made their first contribution in #525
• @AllYouZombies made their first contribution in #508
• @firtk made their first contribution in #535
• @ilius made their first contribution in #558
• @hugovk made their first contribution in #578
• @jgillard made their first contribution in #572
• @hamedsh made their first contribution in #581
• @errrken made their first contribution in #590
• @ppmathis made their first contribution in #605
• @cclauss made their first contribution in #618
• @dependabot made their first contribution in #619
• @plmrn made their first contribution in #615
• @Nathan-Cohen made their first contribution in #620

Full Changelog: v2.2.1...v3.0.0

3.0.0-beta.4

3.0.0-beta.4 (2024-01-02)

Improvements

• feat: If any receiver returns False, no logging will be made. This can be useful if logging should be conditionally enabled / disabled (#590)
• Django: Confirm Django 5.0 support (#598)
• Django: Drop Django 4.1 support (#598)

3.0.0-beta.3

3.0.0-beta.3 (2023-11-13)

Improvements

• Python: Confirm Python 3.12 support (#572)
• feat: thread.local replaced with ContextVar to improve context managers in Django 4.2+

Fixes

• fix: Handle ObjectDoesNotExist in evaluation of object_repr (#592)

3.0.0-beta.2

3.0.0-beta.2 (2023-10-05)

Breaking Changes

• feat: stop deleting old log entries when a model with the same pk is created (i.e. the pk value is reused) (#559)

Fixes

• fix: only fire the post_log signal when the log is created or when there is an error in the process (#561)
• fix: don't set the correlation_id if the AUDITLOG_CID_GETTER is None (#565)

3.0.0-beta.1

3.0.0-beta.1

Breaking Changes

• feat: Change LogEntry.change field type to JSONField rather than TextField. This change include a migration that may take time to run depending on the number of records on your LogEntry table (#407)(#495)
• Python: Drop support for Python 3.7 (#546)
• feat: Set AuditlogHistoryField.delete_related to False by default. This is different from the default configuration of Django's GenericRelation, but we should not erase the audit log of objects on deletion by default. (#557)

Improvements

• Changes the view when it has changes in fields JSONField. The JSONField.encoder is assigned to json.dumps. (#489)
• feat: Added support for Correlation ID. (#481)
• feat: Added pre-log and post-log signals. (#483)
• feat: Make timestamp in LogEntry overwritable. (#476)
• feat: Support excluding field names globally when AUDITLOG_INCLUDE_ALL_MODELS is enabled. (#498)
• feat: Improved auto model registration to include auto-created models and exclude non-managed models, and automatically register m2m fields for models. (#550)

Fixes

• fix: Audit changes to FK fields when saved using *_id naming. (#525)
• fix: Fix a bug in audit log admin page when USE_TZ=False. (#511)
• fix: Make sure LogEntry.changes_dict() returns an empty dict instead of None when json.loads() returns None. (#472)
• fix: Always set remote_addr even if the request has no authenticated user. (#484)
• fix: Fix a bug in getting field's verbose_name when model is not accessible. (508)
• fix: Fix a bug in serialized_data with F expressions. (508)
• fix: Make log entries read-only in the admin. (#449, #556) (applied again after being reverted in 2.2.2)

1.0 alpha 1

This release adds support for Django 3.0, and drops support for Python 2 and unsupported Django versions (most notably Django 1.11).

Overview of changes: #263

0.4.5

Added support for Django 2.0, along with a number of bug fixes.

0.4.4

Release notes to be added soon.

0.4.3

Fixes

• Fixes cricital bug in admin mixin making the library only usable on Django 1.11 (thanks, @audiolion)

0.4.2

As it turns out, haste is never good. Due to the focus on quickly releasing this version a nasty bug was not spotted, which makes this version only usable with Django 1.11 and above. Upgrading to 0.4.3 is not only encouraged but most likely necessary. Apologies for the inconvenience and lacking quality control.

Improvements

• Models can be registered with decorators now (thanks @skorokithakis)

Fixes

• A lot, yes, really a lot, of fixes for the admin integration, with thanks to @Kurocon, @chris-griffin, @fernandoe, @skorokithakis and @fsniper.
• Flush command fixed for Django 1.10 (thanks @goodmase)