From 2259bc050cbfddea8b4692eec1c700ea60355aed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= <anarcat@koumbit.org>
Date: Wed, 7 Oct 2015 09:37:59 -0400
Subject: [PATCH] more reshuffling of release docs

mention that binaries should be signed
clarify where release milestones
reword all steps to be executive
---
 docs/development.rst | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/docs/development.rst b/docs/development.rst
index 493998ea3..fda1bf36e 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -96,31 +96,35 @@ Creating a new release
 
 Checklist::
 
-- all issues for this milestone closed?
-- any low hanging fruit left on the issue tracker?
-- run tox on all supported platforms via vagrant, check for test fails.
-- is Travis CI happy also?
-- update CHANGES.rst (compare to git log)
-- check version number of upcoming release
-- check MANIFEST.in and setup.py - are they complete?
+- make sure all issues for this milestone are closed or moved them to
+  the next milestone
+- look and fix any low hanging fruit left on the issue tracker
+- run tox on all supported platforms via vagrant, check for test failures
+- check that Travis CI is also happy
+- update ``CHANGES.rst``, based on ``git log $PREVIOUS_RELEASE..``
+- check version number of upcoming release in ``CHANGES.rst``
+- verify that ``MANIFEST.in`` and ``setup.py`` are complete
 - tag the release::
 
   git tag -s -m "tagged release" 0.26.0
 
-- cd docs ; make html  # to update the usage include files
+- update usage include files::
+
+  cd docs ; make html
+
 - update website with the html (XXX: how?)
 - create a release on PyPi::
 
     python setup.py register sdist upload --identity="Thomas Waldmann" --sign
 
-- close release milestone
+- close release milestone on Github
 - announce on::
 
   - `mailing list <mailto:borgbackup@librelist.org>`_
   - Twitter (XXX: how? where?)
   - `IRC channel <irc://irc.freenode.net/borgbackup>`_ (change ``/topic``
 
-- create standalone binaries and upload them to the Github release
+- create standalone binaries (see below) and upload them to the Github release
 
 
 Creating standalone binaries
@@ -132,9 +136,10 @@ With virtual env activated::
 
   pip install pyinstaller>=3.0  # or git checkout master
   pyinstaller -F -n borg-PLATFORM --hidden-import=logging.config borg/__main__.py
-  ls -l dist/*
+  gpg --armor --detach-sign dist/borg-*
 
 If you encounter issues, see also our `Vagrantfile` for details.
 
-Note: Standalone binaries built with pyinstaller are supposed to work on same OS,
-      same architecture (x86 32bit, amd64 64bit) without external dependencies.
+.. note:: Standalone binaries built with pyinstaller are supposed to
+          work on same OS, same architecture (x86 32bit, amd64 64bit)
+          without external dependencies.