CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.11] - 2024-09-17

• Add Wagtail 6.2 support
• Drop Django 3.2 support, Add Wagtail 6.1 support
• Drop support for Python 3.8 in preparation for its upcoming end of life
• Fix page chooser not working
• Fix a potential race condition during increment of AB test statistics when using any database besides PostgreSQL

Maintenance

• Resolve several deprecation warnings in the codebase
• Switch from setup.py to pyproject.toml for package metadata
• Format the codebase with ruff

[0.10] - 2024-03-22

• Add support for Wagtail 6.0
• Drop support for Wagtail 4.1, 4.2, 5.0, 5.1
• Adjust styling of create test page and testing log page to match look and feel of Wagtail 5.2 and up
• Add support for dark mode
• Update CloudFlare worker setup docs
• Move in-page script to tracker.js
• Maintenance: update all frontend dependencies to latest versions

[0.9] - 2023-12-14

• Add missing migration
• Remove outdated css file
• Set cookie path to URL of homepage
• Fix Safari JS error accessing window.external
• Support for Python 3.12 and Django 5.0
• Test for missing migrations

[0.8] - 2023-11-16

• Wagtail 4.1, 4.2, 5.0, 5.1 and 5.2 support 🎉
• NO SUPPORT for Wagtail 4.0 and older, sorry
• Revisions that are part of A/B test are now marked as protected to avoid data loss when the revision is deleted

Maintenance

• The package was moved to Wagtail Nest
• Move to GitHub Actions for CI
• Move to Codecov for coverage
• Add Trusted Publishing for publishing to PyPI
• Upload wheels to PyPI for faster installs

[0.7] - 2022-03-31

• Add default_auto_field
• Add reuqest obejct to AbTestActionMenu context]

0.6 - 2021-10-27

• Support for Wagtail 2.15

0.5 - 2021-09-30

Added

• Support for Wagtail 2.14

0.4 - 2021-07-20

Added

• Support for global goal event types

Changed

• Rewritten the docs in the readme for improved clarity.

Fixed

• Set a long expiry date on cookies so users don't get counted multiple times

0.3.1 - 2021-07-08

Fixed

• API endpoints no longer give CSRF errors when authenticated users visit an A/B testing page
• Fixed incorrect cookie name causing wrong variant to be served to participants

0.3 - 2021-07-08

Added

• Support for Wagtail 2.13, and Django 3.2
• Add a HTTPS redirect in Cloudflare worker

Changed

• The tracking code has been moved into JavaScript to reduce the number of false-positives caused by bots
• The Cloudflare worker has been massively simplified

Upgrading from 0.2.2

Following the installation guide, add the new URL pattern into your urls.py (note this is a separate URL to the one used by the old Cloudflare worker). And add the tracking script HTML tag to your base template

If you use the Cloudflare worker

Before deploying the update to 0.3, you must first update the code to match the latest version in the readme. Note that your A/B tests will temporarily stop working, but this shouldn't have any other impact on your site. They should start working again once you've deployed 0.3.

Remove the following URL pattern from your urls.py (note this is not the same pattern we added in the previous step!):

url(r'^abtestingapi/', include(ab_testing_api)),

And the following setting is no longer required, remove it if you have it in your settings:

WAGTAIL_AB_TESTING = {
    'MODE': 'external',
}