Doing a release¶
Doing a release of cryptography
requires a few steps.
Verifying and upgrading OpenSSL version¶
The release process uses a static build for Windows and OS X wheels. Check that the Windows and OS X Jenkins builders have the latest version of OpenSSL installed before performing the release. If they do not:
Upgrading Windows¶
Run the openssl-release
Jenkins job, then copy the resulting artifacts to
the Windows builders and unzip them in the root of the file system.
Upgrading OS X¶
brew update
and then brew upgrade openssl --universal --build-bottle
to
build a universal library (32-bit and 64-bit) compatible with all Intel Macs.
This can be confirmed by using
lipo -info /usr/local/opt/openssl/lib/libssl.dylib
to see the available
architectures.
Bumping the version number¶
The next step in doing a release is bumping the version number in the software.
- Update the version number in
src/cryptography/__about__.py
. - Update the version number in
vectors/cryptography_vectors/__about__.py
. - Set the release date in the Changelog.
- Do a commit indicating this.
- Send a pull request with this.
- Wait for it to be merged.
Performing the release¶
The commit that merged the version number bump is now the official release
commit for this release. You will need to have gpg
installed and a gpg
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.
Verifying the release¶
You should verify that pip install cryptography
works correctly:
>>> import cryptography
>>> cryptography.__version__
'...'
>>> import cryptography_vectors
>>> cryptography_vectors.__version__
'...'
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¶
- Update the version number to the next major (e.g.
0.5.dev1
) incryptography/__about__.py
andvectors/cryptography_vectors/__about__.py
. - Add new Changelog entry with next version and note that it is under active development
- Send a pull request with these items
- Check for any outstanding code undergoing a deprecation cycle by looking in
cryptography.utils
forDeprecatedIn**
definitions. If any exist open a ticket to increment them for the next release. - Send an email to the mailing list and python-announce announcing the release.