Repository: libcloud Updated Branches: refs/heads/trunk fa709b14a -> fd008a023
Improve release instructions Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/fd008a02 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/fd008a02 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/fd008a02 Branch: refs/heads/trunk Commit: fd008a02329d0222a96c55f3337dbc410ee23f9b Parents: fa709b1 Author: Sebastien Goasguen <[email protected]> Authored: Mon Jul 14 10:56:28 2014 +0200 Committer: Sebastien Goasguen <[email protected]> Committed: Mon Jul 14 10:56:28 2014 +0200 ---------------------------------------------------------------------- docs/committer_guide.rst | 70 ++++++++++++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/fd008a02/docs/committer_guide.rst ---------------------------------------------------------------------- diff --git a/docs/committer_guide.rst b/docs/committer_guide.rst index 3287868..5f49c56 100644 --- a/docs/committer_guide.rst +++ b/docs/committer_guide.rst @@ -83,12 +83,15 @@ preparing a release. * Make sure tests pass on all the supported Python versions (``tox``) * Make sure ``CHANGES`` file is up to date * Make sure ``__version__`` string in ``libcloud/__init__.py`` is up to date +* Remove the ``tox`` directory with ``rm -rf .tox`` +* Remove the _secrets_ file with ``rm test/secrets.py`` 2. Creating release artifacts ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We have a script that runs the required setup.py commands and then hashes -and signs the files. To run it: +and signs the files. You will need the latest version of ``pip`` and the ``wheel`` +package. To run it: .. sourcecode:: bash @@ -102,7 +105,33 @@ This should result in a set of ``apache-libcloud-${VERSION}.{tar.bz2,tar.gz,zip}{,asc,md5,sha1}`` files that are suitable to be uploaded for a release. -3. Uploading release artifacts to Apache servers +Copy the artifacts in another directory, unpack one of them and test it with ``tox``. + +3. Tagging a release +~~~~~~~~~~~~~~~~~~~~ + +Tag the tentative release with a ``-tentative`` postfix. + +.. sourcecode:: bash + + git tag <version> <commit hash> + +For example: + +.. sourcecode:: bash + + git tag v0.15.0-tentative 105b9610835f99704996d861d613c5a9a8b3f8b1 + +4. Upload the release artifacts and start a [VOTE] thread +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Upload all release artifacts including the ``whl`` files to your people.apache.org +space. Then start a [VOTE] thread on the [email protected] mailing list. + +Once the vote has passed tag the release with a new tag, removing the ``-tentative`` postfix. +Upload the release artifacts to Apache servers and Pypi. + +5. Uploading release artifacts to Apache servers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Add release artifacts to the dist SVN repository at @@ -117,20 +146,7 @@ are suitable to be uploaded for a release. are automatically archived and available at https://dist.apache.org/repos/dist/release/libcloud/. -4. Tagging a release -~~~~~~~~~~~~~~~~~~~~ - -.. sourcecode:: bash - - git tag <version> <commit hash> - -For example: - -.. sourcecode:: bash - - git tag v0.13.0 105b9610835f99704996d861d613c5a9a8b3f8b1 - -5. Publishing package to PyPi +6. Publishing package to PyPi ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **For consistency and security reasons packages are always uploaded to PyPi @@ -156,7 +172,7 @@ screenshot below. :width: 700px :align: center -6. Verifying the release artifact check sums +7. Verifying the release artifact check sums ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To verify that nothing went wrong doing the release process, run the @@ -177,21 +193,25 @@ For example ./dist/verify_checksums.sh apache-libcloud-0.13.2 -7. Updating doap_libcloud.rdf file +8. Updating doap_libcloud.rdf file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Add information about the new release to the ``doap_libcloud.rdf`` file in the root of the main code repository. -8. Updating website +9. Updating website ~~~~~~~~~~~~~~~~~~~ -* Update "News" page (``content/news.mdtext`` file) -* Update "Downloads" page (``content/downloads.mdtext`` file) -* Update "Get it" section in the sidebar (``templates/blocks/other.html`` file) +Check out the website using SVN: ``svn co https://svn.apache.org/repos/asf/libcloud/site/trunk`` + +* Upate the front page (``source/index.html`` file) +* Update "Downloads" page (``source/downloads.md`` file) +* Add a blog entry in the ``_posts`` directory. -9. Sending announcements -~~~~~~~~~~~~~~~~~~~~~~~~ +Build the site locally and make sure everything is correct. Check the ``README.md`` file. + +10. Sending announcements +~~~~~~~~~~~~~~~~~~~~~~~~~ * Send a release announcement to {dev,users}@libcloud.apache.org. If it's a major release also send it to [email protected]. @@ -235,6 +255,8 @@ Body:: Release artifacts can be found at <link to your Apache space where a release artifacts can be found>. + KEYS file can found at https://dist.apache.org/repos/dist/release/libcloud/KEYS + Please test the release and post your votes. +/- 1
