From 6cdd34e344d587937e659f95cf974c7f2088efaa Mon Sep 17 00:00:00 2001 From: Michael Kelly Date: Mon, 21 Dec 2015 11:40:36 -0800 Subject: [PATCH] Bump to 2.0.0 for backwards-incompatible fix. --- CHANGELOG.rst | 14 ++++++++++++++ django_browserid/__init__.py | 2 +- docs/user/upgrading.rst | 19 +++++++++++++++++++ 3 files changed, 34 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index b8cff9f..00a5570 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -3,6 +3,20 @@ History ------- +2.0.0 (2015-12-21) +++++++++++++++++++ +- **Backwards Incompatible Change:** Fix behavior of ``browserid_login`` and + ``browserid_logout`` helpers to properly use a blank ``next`` value by + default. This fixes a bug where projects usings the helpers would not use the + ``Verify.success_url``/``Logout.redirect_url`` properties on the login/logout + views. + + This may break custom JavaScript that relies on the ``data-next`` value on + login and logout links generated by these helpers. Affected JavaScript should + instead check the response returned when making login and logout requests to + find the URL to redirect users to. + + 1.0.2 (2015-12-03) ++++++++++++++++++ - Test against the release version of Django 1.9. diff --git a/django_browserid/__init__.py b/django_browserid/__init__.py index e3b58ab..e720295 100644 --- a/django_browserid/__init__.py +++ b/django_browserid/__init__.py @@ -5,7 +5,7 @@ License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. """ -__version__ = '1.0.2' +__version__ = '2.0.0' from django_browserid.auth import ( BrowserIDBackend, diff --git a/docs/user/upgrading.rst b/docs/user/upgrading.rst index 357ca25..5a2eff0 100644 --- a/docs/user/upgrading.rst +++ b/docs/user/upgrading.rst @@ -5,6 +5,25 @@ in the right place. This document describes the major changes required to get your site up to the latest and greatest! +1.0.0 to 2.0.0 +-------------- +2.0.0 introduces a small, but backwards-incompatible change that shouldn't +affect most users. You are only affected if you: + +1. Use the ``browserid_login`` or ``browserid_logout`` template helpers to + generate your login/logout buttons, and +2. Use custom JavaScript that relies on the ``data-next`` attribute on the + buttons generate by these helpers. + +If both of the above apply to you, then you may have to update your custom +JavaScript, as the helpers now default to a blank ``data-next`` value instead +of defaulting to the ``LOGIN_REDIRECT_URL``/``LOGOUT_REDIRECT_URL`` settings. + +The default JavaScript does not rely on this, and it's not expected that any +project relies on this either. Most projects should be able to upgrade to the +new version with no changes. + + 0.10.1 to 1.0.0 --------------- No changes are necessary to switch from 0.10.1 to 1.0.0. ``fancy_tag`` was