Doing a release

Doing a release of cryptography requires a few steps.

Security Releases

In addition to the other steps described below, for a release which fixes a security vulnerability, you should also include the following steps:

  • Request a CVE from MITRE. Once you have received the CVE, it should be included in the Changelog. Ideally you should request the CVE before starting the release process so that the CVE is available at the time of the release.

  • Document the CVE in the git commit that fixes the issue.

  • Ensure that the Changelog entry credits whoever reported the issue and contains the assigned CVE.

  • Publish a GitHub Security Advisory on the repository with all relevant information.

  • The release should be announced on the oss-security mailing list, in addition to the regular announcement lists.

Verifying OpenSSL version

The release process creates wheels bundling OpenSSL for Windows, macOS, and Linux. Check that the Windows, macOS, and Linux builders (the manylinux containers) have the latest OpenSSL. If anything is out of date follow the instructions for upgrading OpenSSL.

Upgrading OpenSSL

Use the upgrading OpenSSL issue template.

Bumping the version number

The next step in doing a release is bumping the version number in the software.

  • Run python bump-version {new_version}

  • 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 git configured to perform signed tags. Once this has happened:

  • Run python release.

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

  • Send an email to the mailing list and python-announce announcing the release.

  • Close the milestone for the previous release on GitHub.

  • For major version releases, send a pull request to pyOpenSSL increasing the maximum cryptography version pin and perform a pyOpenSSL release.

  • Update the version number to the next major (e.g. 0.5.dev1) with python bump-version {new_version}.

  • 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 for DeprecatedIn** definitions. If any exist open a ticket to increment them for the next release.