From 27bb5fefdad74afff34a9ad76f51d4acd2447ccb Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Fri, 4 Jul 2014 11:28:08 -0500 Subject: add openssl version check instructions to release docs --- docs/doing-a-release.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index dd62c794..8c858271 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 are on the latest version of OpenSSL 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``. -- cgit v1.2.3 From 1f1e02f351ba4ed4102094d3bc150c62fa7a0e9f Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 6 Jul 2014 08:52:17 -0500 Subject: expand the release instructions to check windows wheel linking --- docs/doing-a-release.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 8c858271..37bc9b0e 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -7,8 +7,8 @@ Verifying OpenSSL version ------------------------- The release process uses a static build for Windows wheels. Check that the -Windows Jenkins builders are on the latest version of OpenSSL before performing -the release. +Windows Jenkins builders have the latest version of OpenSSL installed +before performing the release. Bumping the version number -------------------------- @@ -33,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 @@ -47,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 ------------------ -- cgit v1.2.3