Skip to content

Commit

Permalink
Update HACKING file and add a new RELEASING file which contains info …
Browse files Browse the repository at this point in the history
…about

creating a release.


git-svn-id: https://svn.apache.org/repos/asf/libcloud/trunk@1186534 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
Kami committed Oct 19, 2011
1 parent 9d80c9c commit 4117991
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 14 deletions.
15 changes: 1 addition & 14 deletions HACKING
Original file line number Original file line Diff line number Diff line change
@@ -1,7 +1,6 @@

General Information General Information
=================== ===================
* URL: http://incubator.apache.org/libcloud/devinfo.html * URL: http://libcloud.apache.org/libcloud/devinfo.html


Git Repositories Git Repositories
=================== ===================
Expand Down Expand Up @@ -73,15 +72,3 @@ Testing
To generate test coverage report run: To generate test coverage report run:


libcloud$ PYTHONPATH=. python setup.py coverage libcloud$ PYTHONPATH=. python setup.py coverage

Making a release
=======

We have a script that runs the required setup.py commands and then hashes
and signs the files. To run it:

cd dist
./release.sh -u yourusername@apache.org

This should result in a set of apache-libcloud-${VERSION}.{tar.bz2,zip}{,asc,md5,sha1}
files that are suitable to be uploaded for a release.
64 changes: 64 additions & 0 deletions RELEASING
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,64 @@
Making a release (for release managers)
=======================================

1. Pre-release check list

- Make sure tests pass on all the supported Python versions (sudo tox)
- Make sure CHANGES file is up to date
- Make sure __version__ string in libcloud/__init__.py is up to date

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:

cd dist
./release.sh -u yourusername@apache.org

This should result in a set of apache-libcloud-${VERSION}.{tar.bz2,zip}{,asc,md5,sha1}
files that are suitable to be uploaded for a release.

3. Uploading release artifacts

- Add release artifacts to the SVN repository at
https://dist.apache.org/repos/dist/release/libcloud/

It may take up to a day for the artifacts to be available on all the
Apache mirrors, but they should be instantly available at
http://www.apache.org/dist/libcloud/.

- If there is more than one older release in the repository, delete the
oldest one. Old releases are automatically archived and available at
https://dist.apache.org/repos/dist/release/libcloud/.

4. Tagging a release

svn copy https://svn.apache.org/repos/asf/libcloud/trunk/ \
https://svn.apache.org/repos/asf/libcloud/tags/<version number> \
-r <release revision number> \
-m "Release <version number>"

5. Publishing package to PyPi

TODO

6. Updating a website and doap_libcloud

- Update "News" page

- Update "Downloads" page

- Update "Get it" section in the sidebar

- Update doap_libcloud.py and add info about the new version

7. Sending announcements

- Send a release announcement to {dev,users}@libcloud.apache.org. If it's a
major release also send it to announce@apache.org.

- Send a release announcement to Twitter

Miscellaneous:

- If needed, use Apache URL shortening service - http://s.apache.org/

0 comments on commit 4117991

Please sign in to comment.