diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-06 15:52:38 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-06 15:52:38 -0800 |
| commit | 89063f687893417e1e5dac2e854a02d92037b6a0 (patch) | |
| tree | a4c4c3610a55ed4efb78575140b458fc7134007b /docs | |
| parent | 8755dbd309ae4eab754385853ac6959bfade588d (diff) | |
| download | cryptography-89063f687893417e1e5dac2e854a02d92037b6a0.tar.gz cryptography-89063f687893417e1e5dac2e854a02d92037b6a0.tar.bz2 cryptography-89063f687893417e1e5dac2e854a02d92037b6a0.zip | |
Update procedure
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/doing-a-release.rst | 27 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
2 files changed, 28 insertions, 0 deletions
diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst new file mode 100644 index 00000000..81349a70 --- /dev/null +++ b/docs/doing-a-release.rst @@ -0,0 +1,27 @@ +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`` and + ``docs/conf.py``. +* 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. Once this has happened: + +* Run ``invoke release {version}``. + +That's all, the release should now be available on PyPI and a tag should be +available in the repository. diff --git a/docs/index.rst b/docs/index.rst index 5eb3de7d..24d6d204 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,4 +78,5 @@ The ``cryptography`` open source project contributing security api-stability + doing-a-release community |