v3.4.0

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #765
• Fix copy-paste error in documentation heading by @zc-mattcen in #760
• Amend setup configuration to include non-python package files by @danbentley in #769
• Drop 'Python 3.9' support by @2ykwang in #773
• Add base manager setting to override default manager use (#747) by @DrCuriosity in #766
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #774
• Update mysql version in test docker-compose by @hramezani in #777
• Add CustomLogEntry model support and update tests: by @mostafaeftekharizadeh in #764
• Bump actions/checkout from 5 to 6 in the github-actions group by @dependabot[bot] in #783
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #782
• Make diffing more robust for polymorphic models by @lukasgraf in #784
• Add new setting to control FK change representation by @fabianallendorf in #779
• Prepare release 3.4.0 by @2ykwang in #787

New Contributors

• @zc-mattcen made their first contribution in #760
• @danbentley made their first contribution in #769
• @DrCuriosity made their first contribution in #766
• @mostafaeftekharizadeh made their first contribution in #764
• @lukasgraf made their first contribution in #784
• @fabianallendorf made their first contribution in #779

Full Changelog: v3.3.0...v3.4.0

v3.3.0

What's Changed

• Use canonical timezone name for Buenos Aires by @EdwardBetts in #736
• added fixes for changes_display_dict when AUDITLOG_STORE_JSON_CHANGES is True by @The-Alchemist in #738
• Add audit log history view to Django Admin by @2ykwang in #743
• Extend CI and local test coverage to MySQL and SQLite by @2ykwang in #744
• Bump actions/checkout from 4 to 5 in the github-actions group by @dependabot[bot] in #752
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci[bot] in #753
• Bump actions/setup-python from 5 to 6 in the github-actions group by @dependabot[bot] in #754
• Fix Expression test compatibility for Django 6.0+ by @2ykwang in #759
• Add I18N Support by @2ykwang in #762
• Fix None type mismatch in change detection by @2ykwang in #763
• Prepare release 3.3.0 by @2ykwang in #756

New Contributors

• @EdwardBetts made their first contribution in #736

Full Changelog: v3.2.1...v3.3.0

v3.2.1

What's Changed

• Add support for Django 5.2 by @mahdirahimi1999 in #730
• added fixes for updates and deletes if AUDITLOG_STORE_JSON_CHANGES is True by @The-Alchemist in #732
• Prepare release 3.2.1 by @hramezani in #733

New Contributors

• @mahdirahimi1999 made their first contribution in #730

Full Changelog: v3.2.0...v3.2.1

v3.2.0

What's Changed

• improve actor_email assignment by @GreatBahram in #720
• new setting: STORE_JSON_CHANGES that intelligently store JSON by @The-Alchemist in #719
• Fix get_field_value field default value handling for Django 6.0 compatibility by @2ykwang in #726
• Add support for custom masking functions by @2ykwang in #725
• Update pre-commit repos by @hramezani in #728
• Prepare release 3.2.0 by @hramezani in #729

New Contributors

• @The-Alchemist made their first contribution in #719

Full Changelog: v3.1.2...v3.2.0

v3.1.2

What's Changed

• Fixed problem when setting django.db.models.functions.Now() in DateTimeField by @hramezani in #635
• Fixed a problem when setting Value(None) in JSONField by @hramezani in #646
• Update postgres to 14 by @hramezani in #649
• Use attname to get pk value by @evanandrews-xrd in #650
• Sync django query and postgres query by @GreatBahram in #653
• update docs by @mohsiniscoding in #662
• Added --no-color args in test migration by @CleitonDeLima in #670
• Added remote port by @CleitonDeLima in #671
• Drop Python 3.8 support by @hramezani in #678
• Confirm Django 5.1 support and drop Django 3.2 support. by @hramezani in #677
• Update pre-commit by @hramezani in #679
• feat: Add truncate option to flush command by @BinDruid in #681
• Add AUDITLOG_TRUNCATE_CHANGES_DISPLAY and AUDITLOG_TRUNCATE_LIMIT by @hoangquochung1110 in #684
• fix: use sender for m2m signal dispatch connection by @cdubz in #686
• Bump codecov/codecov-action from 4 to 5 in the github-actions group by @dependabot in #688
• Add date_hierarchy on timestamp to admin view by @hho6643 in #687
• Add Python 3.13 support by @hramezani in #697
• add actor email by @hamedsh in #641
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #698
• Add ability to globally mask fields by name on all models. by @AMP999 in #702
• Fix changelog by @hramezani in #703
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #704
• Use recommended manager to query related models by @sebastianmanger in #705
• Fix IntegrityError when cloning objects with pk=None (#664) by @kubajecminek in #707
• Let CI also check for missing migrations by @sebastianmanger in #706
• Prepare release 3.1.0 by @jayeff in #714
• CI: Add required pkginfo to release workflow by @jayeff in #715

New Contributors

• @evanandrews-xrd made their first contribution in #650
• @GreatBahram made their first contribution in #653
• @mohsiniscoding made their first contribution in #662
• @BinDruid made their first contribution in #681
• @hoangquochung1110 made their first contribution in #684
• @cdubz made their first contribution in #686
• @hho6643 made their first contribution in #687
• @AMP999 made their first contribution in #702
• @sebastianmanger made their first contribution in #705
• @kubajecminek made their first contribution in #707

Full Changelog: v3.0.0...v3.1.0

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)