aboutsummaryrefslogtreecommitdiffstats
path: root/docs/doing-a-release.rst
blob: 194e82f41296e78f635ab2c493df0df070b67c3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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``.
* 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 which 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__
    '...'

Verify that this is the version you just released.