Release v0.5.0 (#30)

Release and minor fixes: 1. Add badges to ReadTheDocs for latest and stable 2. Fix links to docs in ReadMe 3. Add docs to bumversion
jambonrose · Aug 27, 2017 · a10bdc2 · a10bdc2
1 parent 6c98e3f
commit a10bdc2
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 10 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,9 +1,11 @@
 [bumpversion]
-current_version = 0.4.0
+current_version = 0.5.0
 commit = True
 tag = False
 
 [bumpversion:file:appveyor.yml]
 
+[bumpversion:file:docs/conf.py]
+
 [bumpversion:file:setup.py]
 
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -7,6 +7,27 @@ Next Release
 
 - Nothing yet!
 
+0.5.0 (2017-08-26)
+------------------
+
+- Provide documentation for the package. This includes Sphinx
+  documentation hosted on ReadTheDocs.org, (`#26`_, `#29`_), but also
+  documents to help contribute to github more easily (`#26`_) as well as
+  a code of conduct (`#26`_). The Read Me includes badges (`#26`_).
+- In the event the documentation isn't enough, the project now includes
+  an example project demonstrating integration of django-improved-user
+  with Django as well as django-registration. (`#28`_) This content is
+  used to create some of the documentation (`#29`_).
+- The ``UserManager`` was setting the ``last_login`` attribute of new users at
+  creation time. Reported in `#25`_, fixed in `#27`_ (``last_login`` is left
+  blank until the user actually logs in).
+
+.. _#25: https://github.com/jambonsw/django-improved-user/issues/25
+.. _#26: https://github.com/jambonsw/django-improved-user/pull/26
+.. _#27: https://github.com/jambonsw/django-improved-user/pull/27
+.. _#28: https://github.com/jambonsw/django-improved-user/pull/28
+.. _#29: https://github.com/jambonsw/django-improved-user/pull/29
+
 0.4.0 (2017-08-14)
 ------------------
 

diff --git a/README.rst b/README.rst
@@ -1,5 +1,7 @@
 Latest Release: |Version| |Tag|
 
+Documentation: |StableDocs| |DevelopmentDocs|
+
 Compatibility: |Implementation| |Python| |Django| |License|
 
 Tests: |Travis| |AppVeyor| |Coverage| |PyUp|
@@ -12,6 +14,14 @@ Tests: |Travis| |AppVeyor| |Coverage| |PyUp|
         :target: https://github.com/jambonsw/django-improved-user/releases
         :alt: Github Tag
 
+.. |StableDocs| image:: https://readthedocs.org/projects/django-improved-user/badge/?version=stable
+        :target: http://django-improved-user.readthedocs.io/en/stable/?badge=stable
+        :alt: Stable Documentation Status
+
+.. |DevelopmentDocs| image:: https://readthedocs.org/projects/django-improved-user/badge/?version=latest
+        :target: http://django-improved-user.readthedocs.io/en/latest/?badge=latest
+        :alt: Development Documentation Status
+
 .. |Implementation| image:: https://img.shields.io/pypi/implementation/django-improved-user.svg
         :target: https://pypi.python.org/pypi/django-improved-user/
         :alt: Python Implementation Support
@@ -60,5 +70,5 @@ For information about getting started, please refer to the `quickstart
 documentation`_. For information about how to help with the project,
 please see the `contributing documentation`_.
 
-.. _contributing documentation: https://django-improved-user.readthedocs.io/en/development/contributing.html
-.. _quickstart documentation: https://django-improved-user.readthedocs.io/en/development/quickstart.html
+.. _contributing documentation: https://django-improved-user.readthedocs.io/en/latest/contributing.html
+.. _quickstart documentation: https://django-improved-user.readthedocs.io/en/stable/quickstart.html
diff --git a/appveyor.yml b/appveyor.yml
@@ -1,5 +1,5 @@
 # https://www.appveyor.com/docs/appveyor-yml/
-version: '{branch}-v0.4.0-{build}'
+version: '{branch}-v0.5.0-{build}'
 branches:
   only:
   - development

diff --git a/docs/conf.py b/docs/conf.py
@@ -163,9 +163,9 @@ def setup(app):
 # built documents.
 #
 # The short X.Y version.
-version = '0.4.0'
+version = '0.5.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.4.0'
+release = '0.5.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -16,15 +16,15 @@ In a Terminal, use :code:`pip` to install the package from `PyPI`_.
 
 .. code:: console
 
-    pip install django-improved-user
+    $ pip install django-improved-user
 
 If you intend to use the :class:`~improved_user.factories.UserFactory` provided by the package to
 allow for testing with |factory_boy|_, you can specify so during
 install.
 
 .. code:: console
 
-    pip install django-improved-user[factory]
+    $ pip install django-improved-user[factory]
 
 If you do not but wish to use the :code:`UserFactory`, you will need to
 install |factory_boy|_ yourself.

diff --git a/setup.py b/setup.py
@@ -139,7 +139,7 @@ def run_tests(self):
 
 setup(
     name='django-improved-user',
-    version='0.4.0',
+    version='0.5.0',
     description=(
         'A custom Django user model for best practices email-based login.'
     ),
@@ -171,7 +171,7 @@ def run_tests(self):
     ),
     license='Simplified BSD License',
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',