docs: Performing a release

Author: pyroscope

README.rst

@@ -62,6 +62,44 @@ Use ``paver`` to run common project tasks::
     paver coverage
 
 
+Performing a Release
+--------------------
+
+#. Check Travis CI status at https://travis-ci.org/pyroscope/pyrobase
+
+#. Check for and fix ``pylint`` violations::
+
+    paver lint -m
+
+#. Verify ``debian/changelog`` for completeness and the correct version, and bump the release date::
+
+    dch -r
+
+#. Remove ‘dev’ version tagging from ``setup.cfg``, and perform a release check::
+
+    sed -i -re 's/^(tag_[a-z ]+=)/##\1/' setup.cfg
+    paver release
+
+#. Commit and tag the release::
+
+    git status  # check all is committed
+    tag="v$(dpkg-parsechangelog | grep '^Version:' | awk '{print $2}')"
+    git tag -a "$tag" -m "Release $tag"
+
+#. Build the final release and upload it to PyPI::
+
+    paver sdist bdist_wheel
+    twine upload dist/*.{zip,whl}
+
+#. Create the ZIP file with the API documentation::
+
+    paver dist_docs
+
+#. Upload the docs from the ``dist`` directory to ``pythonhosted.org``::
+
+    xdg-open "https://pypi.python.org/pypi?%3Aaction=pkg_edit&name=pyrobase" &
+
+
 Acknowledgements
 ----------------