blob: d790523b6cf530ef25bee59cfe123aee5586ffe1 [file] [log] [blame]
Alex Gaynor89063f62014-01-06 15:52:38 -08001Doing a Release
2===============
3
4Doing a release of ``cryptography`` is a two part process.
5
6Bumping the version number
7--------------------------
8
9The first step in doing a release is bumping the version number in the
10software.
11
Alex Gaynorce0b5a32014-01-06 16:53:31 -080012* Update the version number in ``cryptography/__about__.py``.
Alex Gaynor89063f62014-01-06 15:52:38 -080013* Do a commit indicating this.
14* Send a pull request with this.
15* Wait for it to be merged.
16
17Performing the release
18----------------------
19
20The commit which merged the version number bump is now the official release
21commit for this release. Once this has happened:
22
23* Run ``invoke release {version}``.
24
25That's all, the release should now be available on PyPI and a tag should be
26available in the repository.