aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2014-07-07 14:22:47 +0100
committerAlex Stapleton <alexs@prol.etari.at>2014-07-07 14:22:47 +0100
commit625edcabb8f1a6e11ae25f92facc0eafd76a4cbe (patch)
tree2ae10cb379b13de130f641431969d3cfc4f4a813 /docs
parent0c71ed7ebf9786e9751adcd6b025939776d9d57d (diff)
parent1f1e02f351ba4ed4102094d3bc150c62fa7a0e9f (diff)
downloadcryptography-625edcabb8f1a6e11ae25f92facc0eafd76a4cbe.tar.gz
cryptography-625edcabb8f1a6e11ae25f92facc0eafd76a4cbe.tar.bz2
cryptography-625edcabb8f1a6e11ae25f92facc0eafd76a4cbe.zip
Merge pull request #1213 from reaperhulk/update-release-docs
add openssl version check instructions to release docs
Diffstat (limited to 'docs')
-rw-r--r--docs/doing-a-release.rst23
1 files changed, 19 insertions, 4 deletions
diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst
index dd62c794..37bc9b0e 100644
--- a/docs/doing-a-release.rst
+++ b/docs/doing-a-release.rst
@@ -1,12 +1,19 @@
Doing a release
===============
-Doing a release of ``cryptography`` is a two part process.
+Doing a release of ``cryptography`` requires a few steps.
+
+Verifying OpenSSL version
+-------------------------
+
+The release process uses a static build for Windows wheels. Check that the
+Windows Jenkins builders have the latest version of OpenSSL installed
+before performing the release.
Bumping the version number
--------------------------
-The first step in doing a release is bumping the version number in the
+The next step in doing a release is bumping the version number in the
software.
* Update the version number in ``cryptography/__about__.py``.
@@ -26,8 +33,12 @@ key in order to do a release. Once this has happened:
* Run ``invoke release {version}``.
The release should now be available on PyPI and a tag should be available in
-the repository. You should verify that ``pip install cryptography`` works
-correctly:
+the repository.
+
+Verifying the release
+---------------------
+
+You should verify that ``pip install cryptography`` works correctly:
.. code-block:: pycon
@@ -40,6 +51,10 @@ correctly:
Verify that this is the version you just released.
+For the Windows wheels check the builds for the ``cryptography-wheel-builder``
+job and verify that the final output for each build shows it loaded and linked
+the expected OpenSSL version.
+
Post-release tasks
------------------