From 89063f687893417e1e5dac2e854a02d92037b6a0 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 6 Jan 2014 15:52:38 -0800 Subject: Update procedure --- docs/doing-a-release.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/doing-a-release.rst (limited to 'docs/doing-a-release.rst') 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. -- cgit v1.2.3 From ce0b5a3a8a5d2bb9de1680a9e9ea6e488d33da27 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 6 Jan 2014 16:53:31 -0800 Subject: Update release docs --- docs/doing-a-release.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/doing-a-release.rst') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 81349a70..d790523b 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -9,8 +9,7 @@ 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``. +* Update the version number in ``cryptography/__about__.py``. * Do a commit indicating this. * Send a pull request with this. * Wait for it to be merged. -- cgit v1.2.3 From b3794dbe97a6f4e088244adfdd6a06b2d4e185e0 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 7 Jan 2014 09:25:54 -0800 Subject: You need a gpg key to do a release --- docs/doing-a-release.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/doing-a-release.rst') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index d790523b..77582a48 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -18,7 +18,8 @@ Performing the release ---------------------- The commit which merged the version number bump is now the official release -commit for this release. Once this has happened: +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}``. -- cgit v1.2.3 From fea893c7060c57fe5ed9e0f9df58fee5c306681b Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 7 Jan 2014 11:06:51 -0800 Subject: More stuff --- docs/doing-a-release.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/doing-a-release.rst') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 77582a48..e52c2728 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -23,5 +23,6 @@ key in order to do a 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. +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. -- cgit v1.2.3 From 41c14d55ea2d17e3e9968acfa93d442615f7cda0 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 7 Jan 2014 11:19:08 -0800 Subject: How to verify that your released correctly --- docs/doing-a-release.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'docs/doing-a-release.rst') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index e52c2728..0f382064 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -25,4 +25,12 @@ key in order to do a release. Once this has happened: 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. +correctly: + +.. code-block:: pycon + + >>> import cryptography + >>> cryptography.__version__ + '...' + +Verify that this is the version you just released. -- cgit v1.2.3 From 3f23040fca700b9e15c528ebdebd67764e7cec2c Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 8 Jan 2014 09:21:57 -0800 Subject: Fixed #428 -- added a changelog --- docs/doing-a-release.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/doing-a-release.rst') diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 0f382064..194e82f4 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -10,6 +10,7 @@ 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. -- cgit v1.2.3