Merge pull request #58 from jamescooke/bump-v0.5.0

Bump v0.5.0

CHANGELOG.rst

@@ -14,6 +14,9 @@ Unreleased_
 See also `latest documentation
 <https://flake8-aaa.readthedocs.io/en/latest/>`_.
 
+0.5.0_ - 2018/11/01
+-------------------
+
 Added
 -----
 
@@ -77,7 +80,8 @@ Fixed
 
 Initial alpha release.
 
-.. _Unreleased: https://github.com/jamescooke/flake8-aaa/compare/v0.4.0...HEAD
+.. _Unreleased: https://github.com/jamescooke/flake8-aaa/compare/v0.5.0...HEAD
+.. _0.5.0: https://github.com/jamescooke/flake8-aaa/compare/v0.4.0...v0.5.0
 .. _0.4.0: https://github.com/jamescooke/flake8-aaa/compare/v0.3.0...v0.4.0
 .. _0.3.0: https://github.com/jamescooke/flake8-aaa/compare/v0.2.0...v0.3.0
 .. _0.2.0: https://github.com/jamescooke/flake8-aaa/compare/v0.1.0...v0.2.0

docs/index.rst

@@ -10,3 +10,4 @@ Welcome to Flake8-AAA's documentation
     discovery
     rules
     commands
+    release_checklist

docs/release_checklist.rst

@@ -0,0 +1,71 @@
+Release checklist
+=================
+
+Items to be completed before and after each release.
+
+Pre-release steps
+-----------------
+
+Given a new version called ``x.y.z``:
+
+* Create a branch for the new release. Usually called something like
+  ``bump-vx.y.z``.
+
+* Update ``__version__`` in `__about__.py
+  <https://github.com/jamescooke/flake8-aaa/blob/master/flake8_aaa/__about__.py>`_
+  with the new version number ``'x.y.z'``.
+
+* Update `CHANGELOG <https://github.com/jamescooke/flake8-aaa/blob/master/CHANGELOG.rst>`_.
+
+  - Add a new subtitle below ``Unreleased`` after the note about latest
+    documentation, in the format ``x.y.z_ - yyyy/mm/dd``, where ``yyyy/mm/dd``
+    is the reverse formatted date of the day the release is created.
+
+  - Update the ``.. _Unreleased:`` link at the bottom of the page to compare
+    ``vx.y.z...HEAD``.
+
+  - Under the ``_Unreleased`` link, create a new link for the release
+    ``.. _x.y.z: https:/[...]/compare/va.b.c...vx.y.z``, where ``va.b.c`` is
+    the previous release.
+
+* Commit changes and push ``bump-vx.y.z`` branch for testing.
+
+* Now is a good time to build and check the documentation locally.
+
+* When branch ``bump-vx.y.z`` is green, then merge it to ``master``.
+
+* Update master locally and ensure that you remain on master for the rest of
+  the process.
+
+* Test that a build can be shipped to test PyPI with ``make testpypi``. (Every
+  build runs the full clean test suite locally to ensure that nothing has
+  broken before building)
+
+* After successful push, check the `TestPyPI page
+  <https://test.pypi.org/project/pysyncgateway/>`_.
+
+* Then tag the repo with ``make tag``. Add a short message about what the key
+  change is.
+
+* Make the new tag public with ``git push origin --tags``.
+
+* Build and push to PyPI with ``make pypi``.
+
+* After successful push, check the `PyPI page
+  <https://pypi.org/project/pysyncgateway/>`_.
+
+Post release checks
+-------------------
+
+* Visit the `CHANGELOG
+  <https://github.com/jamescooke/flake8-aaa/blob/master/CHANGELOG.rst>`_
+  and ensure that the new release's comparison link works with the new tag.
+
+* Check the `RTD builds
+  <https://readthedocs.org/projects/flake8-aaa/builds/>`_ to ensure that the
+  latest documentation version has been picked up and that the ``stable`` docs
+  are pointed at it.
+
+  A new docs release will not have been created for the new tag as per `this
+  issue <https://github.com/rtfd/readthedocs.org/issues/3508>`_. Click "Build
+  Version:" on the builds page for the new tag to be picked up.

flake8_aaa/__about__.py

@@ -1,6 +1,6 @@
 __short_name__ = 'aaa'
 __iam__ = 'flake8-{}'.format(__short_name__)
-__version__ = '0.4.0'
+__version__ = '0.5.0'
 
 __author__ = 'James Cooke'
 __copyright__ = '2018, {}'.format(__author__)