Skip to content

Commit

Permalink
Prepare for 0.21.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
vkurup committed Jul 25, 2015
1 parent f790a0c commit 745b3bb
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
# The full version, including alpha/beta/rc tags.
release = rapidsms.__version__
# The next version to be released
rapidsms_next_version = '0.21.0'
rapidsms_next_version = '0.22.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/intro/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Django installed::

Now you can use the ``startproject`` management command with the ``template`` option. You just need to specify your project name at the end of the command::

django-admin.py startproject --template=https://github.com/rapidsms/rapidsms-project-template/zipball/release-0.20.0 --extension=py,rst my_project_name
django-admin.py startproject --template=https://github.com/rapidsms/rapidsms-project-template/zipball/release-0.21.0 --extension=py,rst my_project_name

This will create a new project using the name you specified. Inside your project, you'll find a *README.rst* file with instructions to setup your project.

Expand Down
6 changes: 3 additions & 3 deletions docs/releases/0.20.0.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
===============================================
RapidSMS 0.20.0 release notes (current release)
===============================================
=============================
RapidSMS 0.20.0 release notes
=============================

Welcome to RapidSMS 0.20.0! These release notes cover the new features in 0.20.0
as well as some :ref:`backwards-incompatible-changes-0.20.0` you'll want to be
Expand Down
45 changes: 40 additions & 5 deletions docs/releases/0.21.0.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=================================================
RapidSMS 0.21.0 release notes (under development)
=================================================
===============================================
RapidSMS 0.21.0 release notes (current release)
===============================================

Welcome to RapidSMS 0.21.0! These release notes cover the new features in 0.21.0
as well as some :ref:`backwards-incompatible-changes-0.21.0` you'll want to be
Expand All @@ -10,11 +10,46 @@ aware of when upgrading from RapidSMS 0.20.0.
What's New
==========

*
* Fix 'missing migration' issues `#459 <https://github.com/rapidsms/rapidsms/issues/459>`_
and `#460 <https://github.com/rapidsms/rapidsms/issues/460>`_
* (Fixed `#465 <https://github.com/rapidsms/rapidsms/issues/465>`_) Allow backends to specify
failed identities back to router.
* (Fixed `#439 <https://github.com/rapidsms/rapidsms/issues/439>`_) Allow newlines in
KeywordHandler. [Thanks `@knightsamar <https://github.com/knightsamar>`_!]

.. _backwards-incompatible-changes-0.21.0:

Backwards-incompatible changes in RapidSMS 0.21.0
=================================================

*
* The fix for #460 involves dropping a table which was inadvertently created by a complicated bug.
The table is the ``BackendMessage`` which *should not* have valuable data in it, and there is a
migration included which should copy any data to the proper table, but we recommend that you back
up your database before making this upgrade, especially if you have valuable data in the
BackendMessage table.

* The fix for #465 slightly alters the API between Backends and Routers. Previously, there was only
one way for the Backend to communicate information about the status of outgoing messages back to
the Router. It could raise an exception. The problem is that it's possible that the Backend was
responsible for sending a message to multiple identities and that some of those messages could be
successful and some could fail. Routers that automatically retry failures (only the
``DatabaseRouter``, currently) had no way of knowing which identities failed, so if they just retried
all failures, then some identities would receive multiple messages. The fix for #465 allows
Backends to add a ``failed_identities`` parameter to the exception, which allows the Router to
retry failures more intelligently.

What should you change? Changes are optional. Things should work as they did before without
changes, but the following changes may improve reliability:

* Router authors: Look at the ``DatabaseRouter`` for a working example of how to deal with
``failed_identities``. Basically, it calls ``Router.send_to_backend``, catching any Exception
and looking for a ``failed_identities`` parameter. It then can retry only those identities.

* Backend authors: ``Backend.send`` should try sending messages to all identities, keeping a list
of failures and returning that list in the exception. If there are no failures, then it should
return None. Making this change will allow specific Routers to behave more intelligently. See
the new documentation for ``Backend.send``, which is copied below:

.. autoclass:: rapidsms.backends.base.BackendBase
:noindex:
:members: send
20 changes: 20 additions & 0 deletions docs/releases/0.22.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
=================================================
RapidSMS 0.22.0 release notes (under development)
=================================================

Welcome to RapidSMS 0.22.0! These release notes cover the new features in 0.22.0
as well as some :ref:`backwards-incompatible-changes-0.22.0` you'll want to be
aware of when upgrading from RapidSMS 0.21.0.


What's New
==========

*

.. _backwards-incompatible-changes-0.22.0:

Backwards-incompatible changes in RapidSMS 0.22.0
=================================================

*
6 changes: 4 additions & 2 deletions docs/releases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ you what’s new in each version, describe any backwards-incompatible changes
made, and provide, if needed, any upgrade instructions. Please see the
:doc:`roadmap` for details on upcoming releases.

.. * :doc:`0.21.0 release notes <0.21.0>` (under development)
.. * :doc:`0.20.0 release notes <0.20.0>` (current release)
.. * :doc:`0.22.0 release notes <0.22.0>` (under development)
.. * :doc:`0.21.0 release notes <0.21.0>` (current release)
.. * :doc:`0.20.0 release notes <0.20.0>`
.. * :doc:`0.19.0 release notes <0.19.0>`
.. * :doc:`0.18.0 release notes <0.18.0>`
.. * :doc:`0.17.0 release notes <0.17.0>`
Expand All @@ -24,6 +25,7 @@ made, and provide, if needed, any upgrade instructions. Please see the
.. toctree::
:maxdepth: 1

0.22.0
0.21.0
0.20.0
0.19.0
Expand Down
2 changes: 1 addition & 1 deletion rapidsms/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"Build SMS applications with Python and Django"


__version__ = '0.20.0'
__version__ = '0.21.0'

0 comments on commit 745b3bb

Please sign in to comment.