| Doing a release |
| =============== |
| |
| Doing a release of ``cryptography`` is a two part process. |
| |
| Bumping the version number |
| -------------------------- |
| |
| The first step in doing a release is bumping the version number in the |
| software. |
| |
| * Update the version number in ``cryptography/__about__.py``. |
| * Update the version number in ``vectors/cryptography_vectors/__about__.py``. |
| * Set the release date in the :doc:`/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. You should verify that ``pip install cryptography`` works |
| correctly: |
| |
| .. code-block:: pycon |
| |
| >>> import cryptography |
| >>> cryptography.__version__ |
| '...' |
| >>> import cryptography_vectors |
| >>> cryptography_vectors.__version__ |
| '...' |
| |
| Verify that this is the version you just released. |
| |
| Post-release tasks |
| ------------------ |
| |
| * Update the version number to the next major (e.g. ``0.5.dev1``) in |
| ``cryptography/__about__.py`` and |
| ``vectors/cryptography_vectors/__about__.py``. |
| * Add new :doc:`/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. |
| * Send an email to the `mailing list`_ announcing the release. |
| |
| .. _`mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev |