| Alex Gaynor | 89063f6 | 2014-01-06 15:52:38 -0800 | [diff] [blame] | 1 | Doing a Release |
| 2 | =============== |
| 3 | |
| 4 | Doing a release of ``cryptography`` is a two part process. |
| 5 | |
| 6 | Bumping the version number |
| 7 | -------------------------- |
| 8 | |
| 9 | The first step in doing a release is bumping the version number in the |
| 10 | software. |
| 11 | |
| Alex Gaynor | ce0b5a3 | 2014-01-06 16:53:31 -0800 | [diff] [blame] | 12 | * Update the version number in ``cryptography/__about__.py``. |
| Alex Gaynor | 89063f6 | 2014-01-06 15:52:38 -0800 | [diff] [blame] | 13 | * Do a commit indicating this. |
| 14 | * Send a pull request with this. |
| 15 | * Wait for it to be merged. |
| 16 | |
| 17 | Performing the release |
| 18 | ---------------------- |
| 19 | |
| 20 | The commit which merged the version number bump is now the official release |
| Alex Gaynor | b3794db | 2014-01-07 09:25:54 -0800 | [diff] [blame] | 21 | commit for this release. You will need to have ``gpg`` installed and a ``gpg`` |
| 22 | key in order to do a release. Once this has happened: |
| Alex Gaynor | 89063f6 | 2014-01-06 15:52:38 -0800 | [diff] [blame] | 23 | |
| 24 | * Run ``invoke release {version}``. |
| 25 | |
| Alex Gaynor | fea893c | 2014-01-07 11:06:51 -0800 | [diff] [blame] | 26 | The release should now be available on PyPI and a tag should be available in |
| 27 | the repository. You should verify that ``pip install cryptography`` works |
| 28 | correctly. |