Committer Guide

New committer guidelines

Note

This section outlines steps which need to be completed by new team members and is indented for people who have been voted to join Libcloud project as a committer and / or PMC member. It also assumes you have already filled your ICLA and your Apache account has been created.

First congratulations and welcome to the team!

1. Subscribe to the public mailing lists

If you haven’t yet, subscribe to {dev,users,notifications}@libcloud.apache.org mailing lists. Notifications mailing list is especially important because all of Github Issue, Pull Request and build notifications are sent there.

2. Subscribe to the private mailing list

Subscribe to private@libcloud.apache.org by sending an email to private-subscribe@libcloud.apache.org. Keep in mind that this list is private and your subscription needs to be approved by a moderator.

3. Create PyPi account

Creating a PyPi account by going to https://pypi.python.org/pypi?%3Aaction=register_form and send an email to private@libcloud.apache.org requesting to be added as a maintainer to apache-libcloud package. Make sure to select a strong and unique password (pwgen -s 48 1 is your friend).

After you have registered go to “Your details” page and populate PGP Key ID field with your PGP key ID.

4. Link your ASF and Github account

We use Github for managing issues and user contributions (pull requests). As such, you need to link your Github.com account with your ASF account using Gitbox. This way you will get write access to github.com/apache/libcloud repository and you will be able to manage issues and pull request directly through our Github repository.

Merging user contributions

When a pull request with user contribution (changes) has been reviewed and all the criteria for merging has been met (tests and code coverage, Travis build is passing, user signed an ICLA, etc.), you can directly merge those changes into trunk either by using Github web interface or doing it manually on the command line.

It’s also important that you update changelog in CHANGES.rst file after you merged the changes.

Making a release (for release managers)

This section contains information a release manager should follow when preparing a release.

0. Update committed files

  • Make sure CHANGES file is up to date
  • Make sure __version__ string in libcloud/__init__.py is up to date
  • Make sure version and release in docs/conf.py are up to date
  • Update constants, pricing and other auto-generated data: tox -e scrape-ec2-sizes,scrape-ec2-prices

1. Pre-release check list

  • Make sure tests pass on all the supported Python versions (tox)
  • Remove the tox directory with rm -rf .tox
  • Remove the _secrets_ file with rm libcloud/test/secrets.py
  • Remove leftover builds from previous releases. rm -f dist/apache* ; rm -rf apache_libcloud.egg-info

2. Update Github

  • Create a new Github milestone for the release in question (if one doesn’t exist yet)
  • Update affected issues and pull requests and add the corresponding release milestone to them

3. Creating release artifacts

Note

It’s important that you have the latest versions of setuptools, wheel and pip installed to ensure the generated wheel files contain correct metadata.

We have a script that runs the required setup.py commands and then hashes and signs the files. You will need the latest version of pip and the wheel package. To run it:

  1. cd dist
  2. ./release.sh -u <yourusername>@apache.org

-u argument will be used to find a key with a matching email address in your local GPG database.

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

Copy the artifacts in another directory, unpack one of them and test it with tox.

4. Tagging a release

Tag the tentative release with a -tentative postfix.

  1. git tag <version> <commit hash>

For example:

  1. git tag --sign v0.15.0-tentative 105b9610835f99704996d861d613c5a9a8b3f8b1

5. 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 dev@libcloud.apache.org 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.

For example:

  1. git tag --sign v0.15.0 105b9610835f99704996d861d613c5a9a8b3f8b1

The commit SHA needs to be the one release artifacts are based on (aka the one people voted on) and the same one you used for the -tentative tag.

Keep in mind that it’s important that you sign the commit / tag with your GPG key.

6. Uploading release artifacts to Apache servers

7. Publishing package to PyPi

We have a script that runs uploads the signed Python source files to PyPi. It uses twine, so ensure you have twine available in your path which twine before running. Twine can be downloaded from https://pypi.python.org/pypi/twine

  1. cd dist
  2. ./deploy.sh

Once all the files have been uploaded, the page should look similar to the screenshot below.

_images/pypi_files_page.png

8. Verifying the release artifact check sums

To verify that nothing went wrong doing the release process, run the ./dist/verify_checksums.sh script.

This script downloads the release artifacts from the Apache and PyPi server and makes sure that the MD5 check sums of the both files match.

Usage:

  1. ./dist/verify_checksums.sh <version>

For example

  1. ./dist/verify_checksums.sh apache-libcloud-0.13.2

9. Updating doap_libcloud.rdf, __init__.py

Add information about the new release to the doap_libcloud.rdf file in the root of the main code repository.

Update __version__ attribute in libcloud/__init.py__ file and indicate we are now working on a new release by incrementing a number and adding -dev suffix. For example, if version 2.2.1 has been released you would change it from:

  1. __version__ = '2.2.1'

To:

  1. __version__ = '2.2.2-dev'

10. Updating website

Check out the website using SVN: svn co https://svn.apache.org/repos/asf/libcloud/site/trunk

  • Update the front page (source/index.html file)
  • Update “Downloads” page (source/downloads.md file)
  • Add a blog entry in the _posts directory.

Build the site locally and make sure everything is correct. Check the README.md file.

11. 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 and Google+

Note: If the release fixes a security vulnerability, you should also send information about a vulnerability to the following full disclosure mailing lists:

The email you send should also be signed using your GPG key. You can find an example of such announcement on the following url.

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

Mailing list email templates

This section includes email templates which can be used when sending out official communication to the mailing lists.

Release voting thread template

This template should be used when starting a voting thread for a new release.

Subject:

  1. [VOTE] Release Apache Libcloud <version>

Body:

  1. This is a voting thread for Libcloud <version>.
  3. <short description and highlights of this release>
  5. Full changelog can be found at <link to the CHANGES file for this release>.
  7. Release artifacts can be found at <link to your Apache space where a release
  8. artifacts can be found>.
  10. KEYS file can found at https://dist.apache.org/repos/dist/release/libcloud/KEYS
  12. Please test the release and post your votes.
  14. +/- 1
  15. [  ]  Release Apache Libcloud <version>
  17. Vote will be opened until <date, it should be at minimum today + 3 days> (or longer, if needed).
  19. Thanks,
  20. <name>

For example:

Subject:

  1. [VOTE] Release Apache Libcloud 0.13.2

Body:

  1. This is a voting thread for Libcloud 0.13.2.
  3. This is another primarily a bug-fix release. Previous release included a fix for the Content-Length bug which didn't fully fix the original issue. It missed out "raw" requests which are fixed in this release (LIBCLOUD-396).
  5. This bug could manifest itself while uploading a file with some of the storage providers.
  7. Besides this bug fix, it includes a couple of other smaller bug fixes and changes. Full change log
  8. can be found at https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=b7747f777afdeb63bcacf496d1d034f1b3287c31;hb=c4b3daae946049652a500a8515929b4cbf14a6b4
  10. Release artifacts can be found at http://people.apache.org/~tomaz/libcloud/.
  12. Please test the release and post your votes.
  14. +/- 1
  15. [  ]  Release Apache Libcloud 0.13.2
  17. Vote will be opened until September 18th, 2013 (or longer, if needed).
  19. Thanks,
  20. Tomaz

Release announcement

This template should be used when sending out a release announcement.

Subject:

  1. [ANNOUNCE] Apache Libcloud 0.13.1 release

Body:

  1. Libcloud is a Python library that abstracts away the differences among
  2. multiple cloud provider APIs. It allows users to manage cloud services
  3. (servers, storage, loadbalancers, DNS) offered by many different providers
  4. through a single, unified and easy to use API.
  6. We are pleased to announce the release of Libcloud <version>!
  8. <short description of the release which should include release highlights>
  10. Full change log can be found at <link to CHANGES file for this release>
  12. Download
  14. Libcloud <version> can be downloaded from http://libcloud.apache.org/downloads.html
  15. or installed using pip:
  17. pip install apache-libcloud
  19. Upgrading
  21. If you have installed Libcloud using pip you can also use it to upgrade it:
  23. pip install --upgrade apache-libcloud
  25. Upgrade notes
  27. A page which describes backward incompatible or semi-incompatible
  28. changes and how to preserve the old behavior when this is possible
  29. can be found at http://libcloud.apache.org/upgrade-notes.html.
  31. Documentation
  33. API documentation can be found at http://libcloud.apache.org/apidocs/<version>/.
  35. We also have a new Sphinx documentation which can be found at https://libcloud.apache.org/docs/.
  37. Bugs / Issues
  39. If you find any bug or issue, please report it on our issue tracker
  40. <https://github.com/apache/libcloud/issues>.
  41. Don't forget to attach an example and / or test which reproduces your problem.
  43. Thanks
  45. Thanks to everyone who contributed and made this release possible! Full list of
  46. people who contributed to this release can be found in the CHANGES file
  47. <link to the changes file for this release>.

For example:

Subject:

  1. [ANNOUNCE] Apache Libcloud 0.13.1 release

Body:

  1. Libcloud is a Python library that abstracts away the differences among
  2. multiple cloud provider APIs. It allows users to manage cloud services
  3. (servers, storage, loadbalancers, DNS) offered by many different providers
  4. through a single, unified and easy to use API.
  6. We are pleased to announce the release of Libcloud 0.13.1!
  8. This is a bug-fix only release. Among some smaller bugs it also fixes
  9. Content-Length regression which broke create and update operations in
  10. the Bluebox Compute and Azure Storage driver (LIBCLOUD-362, LIBCLOUD-3901).
  12. Full change log can be found at <https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=ca90c84e296ca82e2206eb86ed7364c588aad503;hb=602b6a7a27dca6990a38eb887e1d6615826387d5>
  14. Download
  16. Libcloud 0.13.1 can be downloaded from http://libcloud.apache.org/downloads.html
  17. or installed using pip:
  19. pip install apache-libcloud
  21. Upgrading
  23. If you have installed Libcloud using pip you can also use it to upgrade it:
  25. pip install --upgrade apache-libcloud
  27. Upgrade notes
  29. A page which describes backward incompatible or semi-incompatible
  30. changes and how to preserve the old behavior when this is possible
  31. can be found at http://libcloud.apache.org/upgrade-notes.html.
  33. Documentation
  35. API documentation can be found at http://libcloud.apache.org/apidocs/0.13.1/.
  37. We also have a new Sphinx documentation which can be found at https://libcloud.apache.org/docs/.
  38. Keep in mind though, that this documentation reflects state in trunk which
  39. includes some backward incompatible changes which aren't present in 0.13.1.
  40. All the examples in the documentation which only work with trunk are clearly marked with a note.
  42. Bugs / Issues
  44. If you find any bug or issue, please report it on our issue tracker
  45. <https://github.com/apache/libcloud/issues>.
  46. Don't forget to attach an example and / or test which reproduces your problem.
  48. Thanks
  50. Thanks to everyone who contributed and made this release possible! Full list of
  51. people who contributed to this release can be found in the CHANGES file
  52. <https://git-wip-us.apache.org/repos/asf?p=libcloud.git;a=blob;f=CHANGES;h=ca90c84e296ca82e2206eb86ed7364c588aad503;hb=602b6a7a27dca6990a38eb887e1d6615826387d5>.